modules/trivia.py

   1 # Erebus IRC bot - Author: Erebus Team
   2 # vim: fileencoding=utf-8
   3 # trivia module
   4 # This file is released into the public domain; see http://unlicense.org/
   5
   6 from __future__ import print_function
   7
   8 # module info
   9 modinfo = {
  10         'author': 'Erebus Team',
  11         'license': 'public domain',
  12         'compatible': [0],
  13         'depends': [],
  14         'softdeps': ['help','userinfo'],
  15 }
  16
  17 # preamble
  18 import modlib
  19 lib = modlib.modlib(__name__)
  20 def modstart(parent, *args, **kwargs):
  21         state.gotParent(parent)
  22         lib.hookchan(state.db['chan'])(trivia_checkanswer) # we need parent for this. so it goes here.
  23         return lib.modstart(parent, *args, **kwargs)
  24 def modstop(*args, **kwargs):
  25         global state
  26         try:
  27                 stop()
  28                 state.closeshop()
  29                 del state
  30         except Exception: pass
  31         return lib.modstop(*args, **kwargs)
  32
  33 # module code
  34 import json, random, threading, re, time, datetime, os, sys
  35
  36 if sys.version_info.major < 3:
  37         timerbase = threading._Timer
  38         stringbase = basestring
  39 else:
  40         import tempfile
  41         timerbase = threading.Timer
  42         stringbase = str
  43
  44
  45 try:
  46         import twitter
  47 except: pass # doesn't matter if we don't have twitter, updating the status just will fall through the try-except if so...
  48
  49 def findnth(haystack, needle, n): #http://stackoverflow.com/a/1884151
  50         parts = haystack.split(needle, n+1)
  51         if len(parts)<=n+1:
  52                 return -1
  53         return len(haystack)-len(parts[-1])-len(needle)
  54
  55 def person(num, throwindexerror=False):
  56         try:
  57                 return state.db['users'][state.db['ranks'][num]]['realnick']
  58         except IndexError:
  59                 if throwindexerror:
  60                         raise
  61                 else:
  62                         return ''
  63
  64 def pts(num):
  65         try:
  66                 return str(state.db['users'][state.db['ranks'][num]]['points'])
  67         except IndexError:
  68                 return 0
  69
  70 def country(num, default="??"):
  71         try:
  72                 return lib.mod('userinfo').get(person(num), 'country', default=default).upper()
  73         except KeyError:
  74                 return default.upper()
  75
  76 class MyTimer(timerbase):
  77         def __init__(self, *args, **kwargs):
  78                 timerbase.__init__(self, *args, **kwargs)
  79                 self.daemon = True
  80
  81 class TriviaState(object):
  82         def __init__(self, parent=None, pointvote=False):
  83                 self.streak = 0
  84                 self.streak_holder = None
  85                 if parent is not None:
  86                         self.gotParent(parent, pointvote)
  87
  88         def gotParent(self, parent, pointvote=False):
  89                 self.parent              = parent
  90                 self.questionfile        = self.parent.cfg.get('trivia', 'jsonpath', default="./modules/trivia.json")
  91                 self.db                  = json.load(open(self.questionfile, "r"))
  92                 self.questions           = self.db['questions'][self.db['category']]
  93                 self.chan                = self.db['chan']
  94                 self.curq                = None
  95                 self.nextq               = None
  96                 self.nextqid             = None
  97                 self.nextquestiontimer   = None
  98                 self.steptimer           = None
  99                 self.hintstr             = None
 100                 self.hintanswer          = None
 101                 self.hintsgiven          = 0
 102                 self.revealpossibilities = None
 103                 self.gameover            = False
 104                 self.missedquestions     = 0
 105                 self.curqid              = None
 106                 self.lastqid             = None
 107
 108                 if 'lastwon' not in self.db or self.db['lastwon'] is None:
 109                         self.db['lastwon'] = time.time()
 110
 111                 if pointvote:
 112                         self.getchan().fastmsg("Vote for the next round target points! Options: %s. Vote using !vote <choice>" % (', '.join([str(x) for x in self.db['targetoptions']])))
 113                         self.getchan().fastmsg("You have %s seconds." % (self.db['votetimer']))
 114                         self.voteamounts = dict([(x, 0) for x in self.db['targetoptions']]) # make a dict {pointsoptionA: 0, pointsoptionB: 0, ...}
 115                         self.pointvote = MyTimer(self.db['votetimer'], self.endPointVote)
 116                         self.pointvote.start()
 117                 else:
 118                         self.pointvote = None
 119
 120 #       def __del__(self):
 121 #               self.closeshop()
 122         def closeshop(self):
 123                 try:
 124                         self.steptimer.cancel()
 125                         self.steptimer = None
 126                 except: pass
 127                 try:
 128                         self.nextquestiontimer.cancel()
 129                         self.nextquestiontimer = None
 130                 except: pass
 131
 132         def savedb(self): #returns whether or not it was able to save
 133                 if json is not None and json.dump is not None:
 134 #                       json.dump(self.db, open(self.questionfile, "w"))#, indent=4, separators=(',', ': '))
 135                         dbjson = json.dumps(self.db)
 136                         # we have to do a dance to save the file to make the update atomic, and also because Py3 doesn't have os.tempnam in the misguided pursuit of "security"
 137                         if len(dbjson) > 0:
 138                                 os.rename(self.questionfile, self.questionfile+".auto.bak")
 139                                 try:
 140                                         # TODO replace both of these with tempfile.NamedTemporaryFile(delete=False, dir=os.path.dirname(self.questionfile), prefix='trivia') & f.name :
 141                                         if sys.version_info.major < 3:
 142                                                 tmpfn = os.tempnam('.', 'trivia')
 143                                                 f = open(tmpfn, "w")
 144                                         else:
 145                                                 fd, tmpfn = tempfile.mkstemp(dir='.', prefix='trivia')
 146                                                 f = open(fd, "w")
 147                                         f.write(dbjson)
 148                                         f.close()
 149                                         os.rename(tmpfn, self.questionfile)
 150                                         return True
 151                                 except: #if something happens, restore the backup
 152                                         os.rename(self.questionfile+".auto.bak", self.questionfile)
 153                                         try:
 154                                                 os.unlink(tmpfn)
 155                                         except OSError: # temp file is already gone
 156                                                 pass
 157                                         except UnboundLocalError:
 158                                                 pass
 159                                         raise
 160                 return False
 161
 162         def getchan(self):
 163                 return self.parent.channel(self.chan)
 164         def getbot(self):
 165                 return self.getchan().bot
 166
 167         def nexthint(self, hintnum):
 168                 answer = self.hintanswer
 169
 170                 if self.hintstr is None or self.revealpossibilities is None or self.reveal is None:
 171                         oldhintstr = ""
 172                         self.hintstr = list(re.sub(r'[a-zA-Z0-9]', '*', answer))
 173                         self.revealpossibilities = list(range(''.join(self.hintstr).count('*')))
 174                         self.reveal = int(round(''.join(self.hintstr).count('*') * (7/24.0)))
 175                 else:
 176                         oldhintstr = ''.join(self.hintstr)
 177
 178                 try:
 179                         for i in range(self.reveal):
 180                                 revealcount = random.choice(self.revealpossibilities)
 181                                 revealloc = findnth(''.join(self.hintstr), '*', revealcount)
 182                                 self.revealpossibilities.remove(revealcount)
 183                                 self.hintstr[revealloc] = answer[revealloc]
 184                 except IndexError: pass # if everything is revealed, random.choice will IndexError
 185                 if oldhintstr != ''.join(self.hintstr): self.getchan().fastmsg("\00304,01Here's a hint: %s" % (''.join(self.hintstr)))
 186
 187                 self.hintsgiven += 1
 188
 189                 if hintnum < self.db['hintnum']:
 190                         self.steptimer = MyTimer(self.db['hinttimer'], self.nexthint, args=[hintnum+1])
 191                         self.steptimer.start()
 192                 else:
 193                         self.steptimer = MyTimer(self.db['hinttimer'], self.nextquestion, args=[True])
 194                         self.steptimer.start()
 195
 196         def doGameOver(self):
 197                 msg = self.getchan().msg
 198                 winner = person(0)
 199                 try:
 200                         msg("\00312THE GAME IS OVER!!!")
 201                         msg("THE WINNER IS: %s (%s)" % (person(0, True), pts(0)))
 202                         msg("2ND PLACE: %s (%s)" % (person(1, True), pts(1)))
 203                         msg("3RD PLACE: %s (%s)" % (person(2, True), pts(2)))
 204                         [msg("%dth place: %s (%s)" % (i+1, person(i, True), pts(i))) for i in range(3,10)]
 205                 except IndexError: pass
 206                 except Exception as e:
 207                         msg("DERP! %r" % (e))
 208
 209                 if self.db['hofpath'] is not None and self.db['hofpath'] != '':
 210                         self.writeHof()
 211
 212                 self.db['lastwinner'] = winner
 213                 self.db['lastwon'] = time.time()
 214
 215                 self.db['users'] = {}
 216                 self.db['ranks'] = []
 217                 self.savedb()
 218                 stop()
 219                 self.closeshop()
 220
 221                 try:
 222                         t = twitter.Twitter(auth=twitter.OAuth(self.getbot().parent.cfg.get('trivia', 'token'),
 223                                 self.getbot().parent.cfg.get('trivia', 'token_sec'),
 224                                 self.getbot().parent.cfg.get('trivia', 'con'),
 225                                 self.getbot().parent.cfg.get('trivia', 'con_sec')))
 226                         t.statuses.update(status="Round is over! The winner was %s" % (winner))
 227                 except: pass #don't care if errors happen updating twitter.
 228
 229                 self.__init__(self.parent, True)
 230
 231         def writeHof(self):
 232                 def person(num):
 233                         try: return self.db['users'][self.db['ranks'][num]]['realnick']
 234                         except: return "none"
 235                 def pts(num):
 236                         try: return str(self.db['users'][self.db['ranks'][num]]['points'])
 237                         except: return 0
 238
 239                 status = False
 240                 f = None
 241                 try:
 242                         f = open(self.db['hofpath'], 'rb+')
 243                         for i in range(self.db['hoflines']): #skip this many lines
 244                                 f.readline()
 245                         insertpos = f.tell()
 246                         fcontents = f.read()
 247                         f.seek(insertpos)
 248                         new_line = self.db['hofformat'] % {
 249                                 'date': time.strftime("%F", time.gmtime()),
 250                                 'duration': str(datetime.timedelta(seconds=time.time()-self.db['lastwon'])),
 251                                 'targetscore': self.db['target'],
 252                                 'firstperson': person(0),
 253                                 'firstscore': pts(0),
 254                                 'secondperson': person(1),
 255                                 'secondscore': pts(1),
 256                                 'thirdperson': person(2),
 257                                 'thirdscore': pts(2),
 258                         }
 259                         f.write(new_line.encode() + b"\n")
 260                         f.write(fcontents)
 261                         status = True
 262                 except Exception as e:
 263                         print(repr(e))
 264                         print(type(e))
 265                         print(e.message)
 266                         status = False
 267                 finally:
 268                         if f is not None:
 269                                 f.close()
 270                         return status
 271
 272         def endPointVote(self):
 273                 self.getchan().msg("Voting has ended!")
 274                 votelist = sorted(self.voteamounts.items(), key=lambda item: (item[1], -item[0])) #sort into list of tuples: [(option, number_of_votes), ...]
 275                 for i in range(len(votelist)-1):
 276                         item = votelist[i]
 277                         self.getchan().msg("%s place: %s (%s votes)" % (len(votelist)-i, item[0], item[1]))
 278                 self.getchan().msg("Aaaaand! The next round will be to \002%s\002 points! (%s votes)" % (votelist[-1][0], votelist[-1][1]))
 279
 280                 self.db['target'] = votelist[-1][0]
 281                 self.pointvote = None
 282
 283                 self.nextquestion() #start the game!
 284
 285         def nextquestion(self, qskipped=False, iteration=0, skipwait=False):
 286                 self.lastqid = self.curqid
 287                 self.curq = None
 288                 self.curqid = None
 289                 self.lastqtime = time.time()
 290                 if self.gameover == True:
 291                         return self.doGameOver()
 292                 if qskipped:
 293                         self.streak = 0
 294                         self.streak_holder = None
 295                         self.getchan().fastmsg("\00304Fail! The correct answer was: %s" % (self.hintanswer))
 296                         self.missedquestions += 1
 297                 else:
 298                         self.missedquestions = 0
 299                         if 'topicformat' in self.db and self.db['topicformat'] is not None:
 300                                 self.getbot().conn.send("TOPIC %s" % (self.db['chan']))
 301
 302                 if isinstance(self.steptimer, MyTimer):
 303                         self.steptimer.cancel()
 304                 if isinstance(self.nextquestiontimer, MyTimer):
 305                         self.nextquestiontimer.cancel()
 306                         self.nextquestiontimer = None
 307
 308                 self.hintstr = None
 309                 self.hintsgiven = 0
 310                 self.revealpossibilities = None
 311                 self.reveal = None
 312
 313                 self.savedb()
 314
 315                 if self.missedquestions > self.db['maxmissedquestions']:
 316                         stop()
 317                         self.getbot().msg(self.getchan(), "%d questions unanswered! Stopping the game." % (self.missedquestions))
 318                         return
 319
 320                 if skipwait:
 321                         self._nextquestion(iteration)
 322                 else:
 323                         self.nextquestiontimer = MyTimer(self.db['questionpause'], self._nextquestion, args=[iteration])
 324                         self.nextquestiontimer.start()
 325
 326         def _nextquestion(self, iteration):
 327                 if self.nextq is not None:
 328                         nextqid = None
 329                         nextq = self.nextq
 330                         self.nextq = None
 331                 elif self.nextqid is not None:
 332                         nextqid = self.nextqid
 333                         nextq = self.questions[nextqid]
 334                         if len(nextq) > 2: nextq[2] = 0 # Unset the time it was last asked.
 335                         self.nextqid = None
 336                 else:
 337                         nextqid = random.randrange(0, len(self.questions))
 338                         nextq = self.questions[nextqid]
 339
 340                 if nextq[0].startswith("!"):
 341                         nextqid = None
 342                         nextq = specialQuestion(nextq)
 343
 344                 if len(nextq) > 2 and time.time() - nextq[2] < 7*24*60*60 and iteration < 10:
 345                         return self._nextquestion(iteration=iteration+1) #short-circuit to pick another question
 346                 if len(nextq) > 2:
 347                         nextq[2] = time.time()
 348                 else:
 349                         nextq.append(time.time())
 350
 351                 if isinstance(nextq[1], stringbase):
 352                         nextq[1] = nextq[1].lower()
 353                 else:
 354                         nextq[1] = [s.lower() for s in nextq[1]]
 355
 356                 qtext = "\00312,01Next up: "
 357                 qtext += "(%5d)" % (random.randint(0,99999))
 358                 qary = nextq[0].split(None)
 359                 qtext += " "
 360                 for qword in qary:
 361                         spacer = random.choice(
 362                                 list(range(0x61,0x7A)) + ([0x20]*4)
 363                         )
 364                         qtext += "\00304,01"+qword+"\00301,01"+chr(spacer) #a-z
 365                 if not self.getbot().fastmsg(self.chan, qtext): #if message is too long:
 366                         if not self.getbot().fastmsg(self.chan, "\00312,01Next up: " + ("(%5d)" % (random.randint(0,99999))) + "\00304,01" + nextq[0]):
 367                                 if not self.getbot().fastmsg(self.chan, "Next up: " + nextq[0]):
 368                                         if nextqid is None: nextqid = "manual"
 369                                         self.getbot().slowmsg(self.chan, "(Unable to ask question #%s: line too long)" % (nextqid))
 370                                         return self._nextquestion(iteration) #retry; don't increment the iteration
 371
 372                 self.curq = nextq
 373                 self.curqid = nextqid
 374
 375                 if isinstance(self.curq[1], stringbase): self.hintanswer = self.curq[1]
 376                 else: self.hintanswer = random.choice(self.curq[1])
 377
 378                 self.steptimer = MyTimer(self.db['hinttimer'], self.nexthint, args=[1])
 379                 self.steptimer.start()
 380
 381         def checkanswer(self, answer):
 382                 if self.curq is None:
 383                         return False
 384                 elif isinstance(self.curq[1], stringbase):
 385                         return answer.lower() == self.curq[1]
 386                 else: # assume it's a list or something.
 387                         return answer.lower() in self.curq[1]
 388
 389         def addpoint(self, user_obj, count=1):
 390                 user_nick = str(user_obj)
 391                 user = user_nick.lower() # save this separately as we use both
 392                 if user in self.db['users']:
 393                         self.db['users'][user]['points'] += count
 394                 else:
 395                         self.db['users'][user] = {'points': count, 'realnick': user_nick, 'rank': len(self.db['ranks'])}
 396                         self.db['ranks'].append(user)
 397
 398                 self.db['ranks'].sort(key=lambda nick: self.db['users'][nick]['points'], reverse=True) #re-sort ranks, rather than dealing with anything more efficient
 399                 for i in range(0, len(self.db['ranks'])):
 400                         nick = self.db['ranks'][i]
 401                         self.db['users'][nick]['rank'] = i
 402
 403                 if self.db['users'][user]['points'] >= self.db['target']:
 404                         self.gameover = True
 405
 406                 return self.db['users'][user]['points']
 407
 408         def points(self, user):
 409                 user = str(user).lower()
 410                 if user in self.db['users']:
 411                         return self.db['users'][user]['points']
 412                 else:
 413                         return 0
 414
 415         def rank(self, user):
 416                 user = str(user).lower()
 417                 if user in self.db['users']:
 418                         return self.db['users'][user]['rank']+1
 419                 else:
 420                         return len(self.db['users'])+1
 421
 422         def get_streak(self, user):
 423                 user = str(user).lower()
 424                 if user in self.db['streaks']:
 425                         return self.db['streaks'][user]
 426                 else:
 427                         return [0,0]
 428
 429         def targetuser(self, user):
 430                 if len(self.db['ranks']) == 0: return "no one is ranked!"
 431
 432                 user = str(user).lower()
 433                 if user in self.db['users']:
 434                         rank = self.db['users'][user]['rank']
 435                         if rank == 0:
 436                                 return "you're in the lead!"
 437                         else:
 438                                 return self.db['ranks'][rank-1]
 439                 else:
 440                         return self.db['ranks'][-1]
 441         def targetpoints(self, user):
 442                 if len(self.db['ranks']) == 0: return 0
 443
 444                 user = str(user).lower()
 445                 if user in self.db['users']:
 446                         rank = self.db['users'][user]['rank']
 447                         if rank == 0:
 448                                 return ""
 449                         else:
 450                                 return "("+str(self.db['users'][self.db['ranks'][rank-1]]['points'])+")"
 451                 else:
 452                         return "("+str(self.db['users'][self.db['ranks'][-1]]['points'])+")"
 453
 454 state = TriviaState()
 455
 456 # we have to hook this in modstart, since we don't know the channel until then.
 457 def trivia_checkanswer(bot, user, chan, *args):
 458         line = ' '.join([str(arg) for arg in args])
 459         if state.checkanswer(line):
 460                 state.curq = None
 461
 462                 if state.streak_holder == user:
 463                         state.streak += 1
 464                 else:
 465                         if state.streak >= 3:
 466                                 bot.fastmsg(chan, "\00312%s\003 broke \00304%s\003's streak of \00307%d\003!" % (user, state.streak_holder, state.streak))
 467                         state.streak_holder = user
 468                         state.streak = 1
 469
 470                 response = "\00312%s\003 got it in %d seconds! The answer was \00312%s\003" % (user, time.time()-state.lastqtime, line)
 471                 if state.hintanswer.lower() != line.lower():
 472                         response += " (hinted answer: %s)" % (state.hintanswer)
 473                 response += ". New score: %d. Rank: %d. Target: %s %s" % (state.addpoint(user), state.rank(user), state.targetuser(user), state.targetpoints(user))
 474                 bot.fastmsg(chan, response)
 475
 476                 user_lower = str(user).lower()
 477                 new_max_streak = ""
 478                 if user_lower not in state.db['streaks']:
 479                         state.db['streaks'][user_lower] = [0, 0]
 480                 if state.streak > state.db['streaks'][user_lower][0]:
 481                         state.db['streaks'][user_lower] = [state.streak, time.time()]
 482                         new_max_streak = " That's a new record for them!"
 483
 484                 if state.streak >= 3:
 485                         bot.msg(chan, "\00312%s\003 is on a streak! \00307%d\003 answers correct in a row!%s" % (user, state.streak, new_max_streak))
 486
 487                 if state.hintsgiven == 0:
 488                         bot.msg(chan, "\00312%s\003 got an extra point for getting it before the hints! New score: %d." % (user, state.addpoint(user)))
 489
 490                 state.nextquestion()
 491
 492 @lib.hook(glevel=1, needchan=False, wantchan=True)
 493 @lib.help(None, "saves the trivia database")
 494 def save(bot, user, chan, realtarget, *args):
 495         if chan is not None: replyto = chan
 496         else: replyto = user
 497
 498         if state.savedb():
 499                 bot.msg(replyto, "Save successful.")
 500         else:
 501                 bot.msg(replyto, "Save failed!")
 502
 503 @lib.hook(needchan=False, wantchan=True)
 504 @lib.help("[<user>]", "shows how many points you or someone has")
 505 def points(bot, user, chan, realtarget, *args):
 506         if chan is not None: replyto = chan
 507         else: replyto = user
 508
 509         if len(args) != 0: who = args[0]
 510         else: who = user
 511
 512         bot.msg(replyto, "%s has %d points." % (who, state.points(who)))
 513
 514 @lib.hook(glevel=lib.STAFF, needchan=False)
 515 @lib.help("<user> [<amount>]", "gives someone points", "defaults to 1 point")
 516 @lib.argsGE(1)
 517 def give(bot, user, chan, realtarget, *args):
 518         whoto = args[0]
 519         if len(args) > 1:
 520                 numpoints = int(args[1])
 521         else:
 522                 numpoints = 1
 523         balance = state.addpoint(whoto, numpoints)
 524
 525         bot.msg(chan, "%s gave %s %d points. New balance: %d" % (user, whoto, numpoints, balance))
 526
 527 @lib.hook(glevel=1, needchan=False)
 528 @lib.help("<qid>", "sets next question to one in the database")
 529 @lib.argsEQ(1)
 530 def setnextid(bot, user, chan, realtarget, *args):
 531         try:
 532                 qid = int(args[0])
 533         except ValueError:
 534                 bot.msg(user, "Error: QID must be a number.")
 535                 return
 536         if qid >= len(state.questions):
 537                 bot.msg(user, "Error: no such QID.")
 538                 return
 539         state.nextqid = qid
 540         bot.msg(user, "Done. Next question is %d: %s" % (qid, state.questions[qid][0]), truncate=True)
 541
 542 @lib.hook(glevel=lib.STAFF, needchan=False)
 543 @lib.help("<q>*<a>", "sets next question to one not in database")
 544 @lib.argsGE(1)
 545 def setnext(bot, user, chan, realtarget, *args):
 546         line = ' '.join([str(arg) for arg in args])
 547         linepieces = line.split('*', 1)
 548         if len(linepieces) < 2:
 549                 bot.msg(user, "Error: need <question>*<answer>")
 550                 return
 551         question = linepieces[0].strip()
 552         answer = linepieces[1].strip()
 553         state.nextq = [question, answer]
 554         bot.msg(user, "Done.")
 555
 556 @lib.hook(glevel=1, needchan=False)
 557 @lib.help(None, "skips to next question")
 558 def skip(bot, user, chan, realtarget, *args):
 559         state.nextquestion(qskipped=True, skipwait=True)
 560
 561 @lib.hook(('start','trivia'), needchan=False, wantchan=True)
 562 @lib.help(None, "starts the trivia game")
 563 def start(bot, user, chan, realtarget, *args):
 564         if chan is not None: replyto = chan
 565         else: replyto = user
 566
 567         if chan is not None and chan.name != state.db['chan']:
 568                 bot.msg(replyto, "That command is only valid in %s" % (state.db['chan']))
 569                 return
 570
 571         if state.curq is None and state.pointvote is None and state.nextquestiontimer is None:
 572                 bot.msg(state.db['chan'], "%s has started the game!" % (user))
 573                 state.nextquestion(skipwait=True)
 574         elif state.pointvote is not None:
 575                 bot.msg(user, "There's a vote in progress!")
 576         else:
 577                 bot.msg(user, "Game is already started!")
 578
 579 @lib.hook('stop', glevel=1, needchan=False)
 580 @lib.help(None, "stops the trivia game")
 581 def cmd_stop(bot, user, chan, realtarget, *args):
 582         if stop():
 583                 bot.msg(state.chan, "Game stopped by %s" % (user))
 584         else:
 585                 bot.msg(user, "Game isn't running.")
 586
 587 def stop():
 588         state.curq = None
 589         state.nextq = None
 590         try:
 591                 state.steptimer.cancel()
 592         except Exception as e:
 593                 print("!!! steptimer.cancel(): %s %r" % (e,e))
 594         state.steptimer = None
 595         try:
 596                 state.nextquestiontimer.cancel()
 597         except Exception as e:
 598                 print("!!! nextquestiontimer.cancel(): %s %r" % (e,e))
 599         state.nextquestiontimer = None
 600         return True
 601
 602 @lib.hook(needchan=False)
 603 @lib.help("<reason>", "reports a bad question to the admins")
 604 @lib.argsGE(1)
 605 def badq(bot, user, chan, realtarget, *args):
 606         lastqid = state.lastqid
 607         curqid = state.curqid
 608
 609         reason = ' '.join(args)
 610         state.db['badqs'].append([state.db['category'], lastqid, curqid, reason])
 611         bot.msg(user, "Reported bad question.")
 612
 613 @lib.hook(glevel=lib.STAFF, needchan=False)
 614 @lib.help(None, "shows a list of BADQ reports")
 615 def badqs(bot, user, chan, realtarget, *args):
 616         if len(state.db['badqs']) == 0:
 617                 bot.msg(user, "No reports.")
 618
 619         for i in range(len(state.db['badqs'])):
 620                 try:
 621                         report = state.db['badqs'][i]
 622                         bot.msg(user, "Report #%d: Cat=%s LastQ=%r CurQ=%r: %s" % (i, report[0], report[1], report[2], report[3]))
 623                         try: lq = state.db['questions'][report[0]][int(report[1])]
 624                         except Exception as e: lq = (None,None)
 625                         try: cq = state.db['questions'][report[0]][int(report[2])]
 626                         except Exception as e: cq = (None, None)
 627                         bot.msg(user, "- Last: %s*%s" % (lq[0], lq[1]))
 628                         bot.msg(user, "- Curr: %s*%s" % (cq[0], cq[1]))
 629                 except Exception as e:
 630                         bot.msg(user, "- Exception: %r" % (e))
 631
 632 @lib.hook(glevel=lib.STAFF, needchan=False)
 633 @lib.hook(None, "clears list of BADQ reports")
 634 def clearbadqs(bot, user, chan, realtarget, *args):
 635         state.db['badqs'] = []
 636         bot.msg(user, "Cleared reports.")
 637
 638 @lib.hook(glevel=lib.STAFF, needchan=False)
 639 @lib.hook("<badqid>", "removes a BADQ report")
 640 @lib.argsEQ(1)
 641 def delbadq(bot, user, chan, realtarget, *args):
 642         try:
 643                 qid = int(args[0])
 644                 del state.db['badqs'][qid]
 645                 bot.msg(user, "Removed report #%d" % (qid))
 646         except:
 647                 bot.msg(user, "Failed!")
 648
 649 @lib.hook(needchan=False, wantchan=True)
 650 @lib.help("[<user>]", "shows you or someone else's rank")
 651 def rank(bot, user, chan, realtarget, *args):
 652         if chan is not None: replyto = chan
 653         else: replyto = user
 654
 655         if len(args) != 0: who = args[0]
 656         else: who = user
 657
 658         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)))
 659
 660 @lib.hook(needchan=False)
 661 @lib.help(None, "shows top10 list")
 662 def top10(bot, user, chan, realtarget, *args):
 663         if len(state.db['ranks']) == 0:
 664                 return bot.msg(state.db['chan'], "No one is ranked!")
 665
 666         max = len(state.db['ranks'])
 667         if max > 10:
 668                 max = 10
 669         replylist = ', '.join(["%s (%s) %s" % (person(x), country(x), pts(x)) for x in range(max)])
 670         bot.msg(state.db['chan'], "Game is to %s! Top 10: %s" % (state.db['target'], replylist))
 671
 672 @lib.hook(glevel=lib.ADMIN, needchan=False)
 673 @lib.help("<target score>", "changes the target score for this round")
 674 def settarget(bot, user, chan, realtarget, *args):
 675         try:
 676                 state.db['target'] = int(args[0])
 677                 bot.msg(state.db['chan'], "Target has been changed to %s points!" % (state.db['target']))
 678
 679                 if state.pointvote is not None:
 680                         state.pointvote.cancel()
 681                         state.pointvote = None
 682                         bot.msg(state.db['chan'], "Vote has been cancelled!")
 683         except Exception as e:
 684                 print(e)
 685                 bot.msg(user, "Failed to set target.")
 686
 687 @lib.hook(needchan=False)
 688 @lib.help("<option>", "votes for a trarget score for next round")
 689 def vote(bot, user, chan, realtarget, *args):
 690         if state.pointvote is not None:
 691                 if int(args[0]) in state.voteamounts:
 692                         state.voteamounts[int(args[0])] += 1
 693                         bot.msg(user, "Your vote has been recorded.")
 694                 else:
 695                         bot.msg(user, "Sorry - that's not an option!")
 696         else:
 697                 bot.msg(user, "There's no vote in progress.")
 698
 699 @lib.hook(glevel=lib.ADMIN, needchan=False)
 700 @lib.help("<number>", "sets the max missed question before game stops")
 701 def maxmissed(bot, user, chan, realtarget, *args):
 702         try:
 703                 state.db['maxmissedquestions'] = int(args[0])
 704                 bot.msg(state.db['chan'], "Max missed questions before round ends has been changed to %s." % (state.db['maxmissedquestions']))
 705         except:
 706                 bot.msg(user, "Failed to set maxmissed.")
 707
 708 @lib.hook(glevel=lib.ADMIN, needchan=False)
 709 @lib.help("<seconds>", "sets the time between hints")
 710 def hinttimer(bot, user, chan, realtarget, *args):
 711         try:
 712                 state.db['hinttimer'] = float(args[0])
 713                 bot.msg(state.db['chan'], "Time between hints has been changed to %s." % (state.db['hinttimer']))
 714         except:
 715                 bot.msg(user, "Failed to set hint timer.")
 716
 717 @lib.hook(glevel=lib.ADMIN, needchan=False)
 718 @lib.help("<number>", "sets the number of hints given")
 719 def hintnum(bot, user, chan, realtarget, *args):
 720         try:
 721                 state.db['hintnum'] = int(args[0])
 722                 bot.msg(state.db['chan'], "Max number of hints has been changed to %s." % (state.db['hintnum']))
 723         except:
 724                 bot.msg(user, "Failed to set hintnum.")
 725
 726 @lib.hook(glevel=lib.ADMIN, needchan=False)
 727 @lib.help("<seconds>", "sets the pause between questions")
 728 def questionpause(bot, user, chan, realtarget, *args):
 729         try:
 730                 state.db['questionpause'] = float(args[0])
 731                 bot.msg(state.db['chan'], "Pause between questions has been changed to %s." % (state.db['questionpause']))
 732         except:
 733                 bot.msg(user, "Failed to set questionpause.")
 734
 735 @lib.hook(glevel=1, needchan=False)
 736 @lib.help("[@category] <question>", "finds a question (qid) given a (partial) question")
 737 @lib.argsGE(1)
 738 def findq(bot, user, chan, realtarget, *args):
 739         args = list(args)
 740         if args[0].startswith("@"):
 741                 cat = args.pop(0)[1:].lower()
 742                 questions = state.db['questions'][cat]
 743         else:
 744                 questions = state.questions
 745
 746         pattern = re.escape(' '.join(args))
 747         return _findq(questions, pattern)
 748
 749 @lib.hook(glevel=1, needchan=False)
 750 @lib.help("[@<category>] <regex>", "finds a question (qid) given a regex")
 751 @lib.argsGE(1)
 752 def findqre(bot, user, chan, realtarget, *args):
 753         args = list(args)
 754         if args[0].startswith("@"):
 755                 cat = args.pop(0)[1:].lower()
 756                 questions = state.db['questions'][cat]
 757         else:
 758                 questions = state.questions
 759         pattern = ' '.join(args)
 760         return _findq(questions, pattern)
 761
 762 @lib.hook(glevel=1, needchan=False)
 763 @lib.help("[@<category>] <phrase>", "finds a question (qid) given a (partial) question or answer")
 764 @lib.argsGE(1)
 765 def findqa(bot, user, chan, realtarget, *args):
 766         args = list(args)
 767         if args[0].startswith("@"):
 768                 cat = args.pop(0)[1:].lower()
 769                 questions = state.db['questions'][cat]
 770         else:
 771                 questions = state.questions
 772         pattern = ' '.join(args)
 773         return _findq(questions, pattern, True)
 774
 775 def _findq(questions, pattern, check_answers=False):
 776         searcher = re.compile(pattern, re.IGNORECASE)
 777         matches = [i for i in range(len(questions)) if searcher.search(questions[i][0]) is not None or (check_answers and searcher.search(questions[i][1]) is not None)]
 778         if len(matches) > 25:
 779                 return "Too many matches! (>25)"
 780         elif len(matches) > 1:
 781                 return "Multiple matches: %s" % (', '.join(str(x) for x in matches))
 782         elif len(matches) == 1:
 783                 i = matches[0]
 784                 return "One match: %s %s*%s" % (i, questions[i][0], questions[i][1])
 785         else:
 786                 return "No match."
 787
 788 @lib.hook(glevel=lib.STAFF, needchan=False)
 789 @lib.help("[@<category>] <qid>", "displays the q*a for a qid", "category defaults to current")
 790 def showq(bot, user, chan, realtarget, *args):
 791         args = list(args)
 792         if args[0].startswith("@"):
 793                 cat = args.pop(0)[1:].lower()
 794                 questions = state.db['questions'][cat]
 795         else:
 796                 questions = state.questions
 797
 798         try:
 799                 qid = int(args[0])
 800         except:
 801                 bot.msg(user, "Specify a numeric question ID.")
 802                 return
 803         try:
 804                 q = questions[qid]
 805         except:
 806                 bot.msg(user, "ID not valid.")
 807                 return
 808         bot.msg(user, "%s: %s*%s" % (qid, q[0], q[1]), True)
 809
 810 @lib.hook(('delq', 'deleteq'), glevel=lib.STAFF, needchan=False)
 811 @lib.help("[@<category>] <qid>", "removes a question from the database")
 812 def delq(bot, user, chan, realtarget, *args):
 813         args = list(args)
 814         if args[0].startswith("@"):
 815                 cat = args.pop(0)[1:].lower()
 816                 questions = state.db['questions'][cat]
 817         else:
 818                 questions = state.questions
 819
 820         try:
 821                 backup = questions[int(args[0])]
 822                 del questions[int(args[0])]
 823                 bot.msg(user, "Deleted %s*%s" % (backup[0], backup[1]), True)
 824         except Exception as e:
 825                 bot.msg(user, "Couldn't delete that question. %r" % (e))
 826
 827 @lib.hook(glevel=lib.STAFF, needchan=False)
 828 @lib.help("[@<category>] <q>*<a>", "adds a question")
 829 def addq(bot, user, chan, realtarget, *args):
 830         args = list(args)
 831         if args[0].startswith("@"):
 832                 cat = args.pop(0)[1:].lower()
 833                 questions = state.db['questions'][cat]
 834         else:
 835                 questions = state.questions
 836
 837         line = ' '.join([str(arg) for arg in args])
 838         linepieces = line.split('*', 1)
 839         if len(linepieces) < 2:
 840                 bot.msg(user, "Error: need <question>*<answer>")
 841                 return
 842         question = linepieces[0].strip()
 843         answer = linepieces[1].strip()
 844         questions.append([question, answer])
 845         bot.msg(user, "Done. Question is #%s" % (len(questions)-1))
 846
 847 @lib.hook(needchan=False)
 848 @lib.help(None, "show current category")
 849 def showcat(bot, user, chan, realtarget, *args):
 850         bot.msg(user, "Current category: %s" % (state.db['category']))
 851
 852 @lib.hook(glevel=1, needchan=False)
 853 @lib.help("<category>", "change category")
 854 def setcat(bot, user, chan, realtarget, *args):
 855         category = args[0].lower()
 856         if category in state.db['questions']:
 857                 state.db['category'] = category
 858                 state.questions = state.db['questions'][category]
 859                 bot.msg(user, "Changed category to %s" % (category))
 860         else:
 861                 bot.msg(user, "That category doesn't exist.")
 862
 863 @lib.hook(needchan=False)
 864 @lib.help(None, "list categories", "the current category will be marked with a *")
 865 def listcats(bot, user, chan, realtarget, *args):
 866         cats = ["%s%s (%d)" % ("*" if c == state.db['category'] else "", c, len(state.db['questions'][c])) for c in state.db['questions'].keys()]
 867         bot.msg(user, "Categories: %s" % (', '.join(cats)))
 868
 869 @lib.hook(glevel=lib.STAFF, needchan=False)
 870 @lib.help("<category>", "adds an empty category")
 871 def addcat(bot, user, chan, realtarget, *args):
 872         category = args[0].lower()
 873         if category not in state.db['questions']:
 874                 state.db['questions'][category] = []
 875                 bot.msg(user, "Added category %s" % (category))
 876         else:
 877                 bot.msg(user, "Category already exists.")
 878
 879 @lib.hook(glevel=lib.MANAGER, needchan=False)
 880 @lib.help("<category>", "deletes an entire category")
 881 def delcat(bot, user, chan, realtarget, *args):
 882         category = args[0].lower()
 883         if category == state.db['category']:
 884                 bot.msg(user, "Category currently in use!")
 885         elif category in state.db['questions']:
 886                 length = len(state.db['questions'][category])
 887                 del state.db['questions'][category]
 888                 bot.msg(user, "Deleted category %s (%d questions)" % (category, length))
 889         else:
 890                 bot.msg(user, "Category does not exist.")
 891
 892 @lib.hook(needchan=False)
 893 @lib.help("[<nick>]", "shows a user's (or your own) max streak")
 894 def streak(bot, user, chan, realtarget, *args):
 895         if chan is not None: replyto = chan
 896         else: replyto = user
 897
 898         if len(args) != 0: who = args[0]
 899         else: who = user
 900
 901         streak = state.get_streak(who)
 902         bot.msg(replyto, "%s's highest streak is %d, set %s" % (who, streak[0], time.strftime("%d %b %Y %H:%M:%S %Z", time.gmtime(streak[1]))))
 903
 904 @lib.hook(needchan=False)
 905 @lib.help(None, "shows top streaks of all time")
 906 def topstreaks(bot, user, chan, realtarget, *args):
 907         db = state.db['streaks']
 908         streaks = [(nick, db[nick][0], db[nick][1]) for nick in db.keys()]
 909         streaks.sort(key=lambda v: v[1], reverse=True)
 910         return "Top streaks of all time: %s (%d), %s (%d), %s (%d)." % (streaks[0][0], streaks[0][1], streaks[1][0], streaks[1][1], streaks[2][0], streaks[2][1])
 911
 912 @lib.hook(glevel=lib.MANAGER, needchan=False)
 913 @lib.help("<nick> <new streak> [<timestamp>]", "set a user's max streak")
 914 @lib.argsGE(2)
 915 def setstreak(bot, user, chan, realtarget, *args):
 916         temp = 0
 917         target = args[0].lower()
 918         try:
 919                 newstreak = int(args[1])
 920         except ValueError:
 921                 return "Error: <new streak> must be integer"
 922         timestamp = time.time()
 923         if len(args) > 2:
 924                 try:
 925                         timestamp = int(args[2])
 926                 except ValueError:
 927                         return "Error: <timestamp> must be integer (unix timestamp)"
 928
 929         if target in state.db['streaks']:
 930                 temp = state.db['streaks'][target]
 931                 if newstreak == 0:
 932                         del state.db['streaks'][target]
 933         if newstreak > 0:
 934                 state.db['streaks'][target] = [newstreak, timestamp]
 935         return "Done. Streak used to be %d set %d" % (temp[0], temp[1])
 936
 937 @lib.hook(needchan=False)
 938 def triviahelp(bot, user, chan, realtarget, *args):
 939         bot.slowmsg(user,             "START")
 940         bot.slowmsg(user,             "TOP10")
 941         bot.slowmsg(user,             "POINTS        [<user>]")
 942         bot.slowmsg(user,             "RANK          [<user>]")
 943         bot.slowmsg(user,             "STREAK        [<user>]")
 944         bot.slowmsg(user,             "TOPSTREAKS")
 945         bot.slowmsg(user,             "BADQ          <reason> (include info to identify question)")
 946         if user.glevel >= 1:
 947                 bot.slowmsg(user,         "SKIP                            (KNOWN)")
 948                 bot.slowmsg(user,         "STOP                            (KNOWN)")
 949                 bot.slowmsg(user,         "FINDQ         <full question>   (KNOWN)")
 950                 bot.slowmsg(user,         "FINDQRE       <regex>           (KNOWN)")
 951                 bot.slowmsg(user,         "SETNEXTID     <qid>             (KNOWN)")
 952                 if user.glevel >= lib.STAFF:
 953                         bot.slowmsg(user,     "GIVE          <user> [<points>] (STAFF)")
 954                         bot.slowmsg(user,     "SETNEXT       <q>*<a>           (STAFF)")
 955                         bot.slowmsg(user,     "ADDQ          <q>*<a>           (STAFF)")
 956                         bot.slowmsg(user,     "DELQ          <q>*<a>           (STAFF)  [aka DELETEQ]")
 957                         bot.slowmsg(user,     "SHOWQ         <qid>             (STAFF)")
 958                         bot.slowmsg(user,     "BADQS                           (STAFF)")
 959                         bot.slowmsg(user,     "CLEARBADQS                      (STAFF)")
 960                         bot.slowmsg(user,     "DELBADQ       <reportid>        (STAFF)")
 961                         if user.glevel >= lib.ADMIN:
 962                                 bot.slowmsg(user, "SETTARGET     <points>          (ADMIN)")
 963                                 bot.slowmsg(user, "MAXMISSED     <questions>       (ADMIN)")
 964                                 bot.slowmsg(user, "HINTTIMER     <float seconds>   (ADMIN)")
 965                                 bot.slowmsg(user, "HINTNUM       <hints>           (ADMIN)")
 966                                 bot.slowmsg(user, "QUESTIONPAUSE <float seconds>   (ADMIN)")
 967                                 bot.slowmsg(user, "SETSTREAK     <nick> <streak>   (ADMIN)")
 968
 969 @lib.hooknum(332) # topic is...
 970 @lib.hooknum(331) # no topic set
 971 def num_TOPIC(bot, textline):
 972         pieces = textline.split(None, 4)
 973         chan = pieces[3]
 974         if chan != state.db['chan']:
 975                 return
 976         gottopic = pieces[4][1:]
 977
 978         formatted = state.db['topicformat'] % {
 979                 'chan': state.db['chan'],
 980                 'top1': "%s (%s)" % (person(0), pts(0)),
 981                 'top3': '/'.join([
 982                         "%s (%s)" % (person(x), pts(x))
 983                         for x in range(3) if x < len(state.db['ranks'])
 984                 ]),
 985                 'top3c': ', '.join([
 986                         "%s (%s) %s" % (person(x), country(x), pts(x))
 987                         for x in range(3) if x < len(state.db['ranks'])
 988                 ]),
 989                 'top10': ' '.join([
 990                         "%s (%s)" % (person(x), pts(x))
 991                         for x in range(10) if x < len(state.db['ranks'])
 992                 ]),
 993                 'top10c': ' '.join([
 994                         "%s (%s, %s)" % (person(x), pts(x), country(x))
 995                         for x in range(10) if x < len(state.db['ranks'])
 996                 ]),
 997                 'lastwinner': state.db['lastwinner'],
 998                 'lastwon': time.strftime("%b %d", time.gmtime(state.db['lastwon'])),
 999                 'target': state.db['target'],
1000                 'category': state.db['category'],
1001         }
1002         if gottopic != formatted:
1003                 state.getbot().conn.send(bot.parent.cfg.get('trivia', 'topiccommand', default="TOPIC %(chan)s :%(topic)s") % {'chan': state.db['chan'], 'topic': formatted})
1004
1005
1006 def specialQuestion(oldq):
1007         newq = [oldq[0], oldq[1]]
1008         qtype = oldq[0].upper()
1009
1010         if qtype == "!MONTH":
1011                 newq[0] = "What month is it currently (in UTC)?"
1012                 newq[1] = time.strftime("%B", time.gmtime()).lower()
1013         elif qtype == "!MATH+":
1014                 try:
1015                         maxnum = int(oldq[1])
1016                 except ValueError:
1017                         maxnum = 10
1018                 randnum1 = random.randrange(0, maxnum+1)
1019                 randnum2 = random.randrange(0, maxnum+1)
1020                 newq[0] = "What is %d + %d?" % (randnum1, randnum2)
1021                 newq[1] = spellout(randnum1+randnum2)
1022         elif qtype == "!ALGEBRA+":
1023                 try:
1024                         num1, num2 = [int(i) for i in oldq[1].split('!')]
1025                 except ValueError:
1026                         num1, num2 = 10, 10
1027                 randnum1 = random.randrange(0, num1+1)
1028                 randnum2 = random.randrange(randnum1, num2+1)
1029                 newq[0] = "What is x? %d = %d + x" % (randnum2, randnum1)
1030                 newq[1] = spellout(randnum2-randnum1)
1031         else: pass #default to not modifying
1032         return newq
1033
1034 def spellout(num):
1035         ones = ['', 'one', 'two', 'three', 'four', 'five', 'six', 'seven', 'eight', 'nine']
1036         teens = ['ten', 'eleven', 'twelve', 'thirteen', 'fourteen', 'fifteen', 'sixteen', 'seventeen', 'eighteen', 'nineteen']
1037         tens = ['', '', 'twenty', 'thirty', 'fourty', 'fifty', 'sixty', 'seventy', 'eighty', 'ninety']
1038
1039         if num == 0:
1040                 return 'zero'
1041
1042         ihundreds = num / 100
1043         itens = num % 100 / 10
1044         iones = num % 10
1045         buf = []
1046
1047         if ihundreds > 0:
1048                 buf.append("%s hundred" % (ones[ihundreds]))
1049         if itens > 1:
1050                 buf.append(tens[itens])
1051         if itens == 1:
1052                 buf.append(teens[iones])
1053         elif iones > 0:
1054                 buf.append(ones[iones])
1055         return ' '.join(buf)
1056 #       return [
1057 #               "zero", "one", "two", "three", "four", "five", "six", "seven", "eight",
1058 #               "nine", "ten", "eleven", "twelve", "thirteen", "fourteen", "fifteen",
1059 #               "sixteen", "seventeen", "eighteen", "nineteen", "twenty"
1060 #       ][num]
1061
1062
1063 def topa():
1064         answers=__import__('collections').defaultdict(int)
1065         for a in (x[1] for x in state.db['questions']['general']):
1066                  answers[a]+=1;
1067         a2=[]
1068         for a, num in answers.items():
1069                 a2.append((a, num))
1070         a2.sort(key=lambda v: v[1], reverse=True)
1071         return a2