commands.py

   1 # Part of Acrobat.
   2 import string, cPickle, random, urllib, sys, time, re, os, twitter
   3 from irclib import irc_lower, nm_to_n
   4
   5 # query karma
   6 def karmaq(bot, cmd, nick, conn, public, karma):
   7     try:
   8         item=cmd.split()[1].lower()
   9     except IndexError:
  10         item=None
  11     if item==None:
  12         bot.automsg(public,nick,"I have karma on %s items." %
  13                          len(karma.keys()))
  14     elif karma.has_key(item):
  15         bot.automsg(public,nick,"%s has karma %s."
  16                      %(item,karma[item]))
  17     else:
  18         bot.automsg(public,nick, "%s has no karma set." % item)
  19
  20 # delete karma
  21 def karmadelq(bot, cmd, nick, conn, public, karma):
  22     try:
  23         item=cmd.split()[1].lower()
  24     except IndexError:
  25         conn.notice(nick, "What should I delete?")
  26         return
  27     if nick != bot.owner:
  28         conn.notice(nick, "You are not my owner.")
  29         return
  30     if karma.has_key(item):
  31         del karma[item]
  32         conn.notice(nick, "Item %s deleted."%item)
  33     else:
  34         conn.notice(nick, "There is no karma stored for %s."%item)
  35
  36 # help - provides the URL of the help file
  37 def helpq(bot, cmd, nick, conn, public):
  38     bot.automsg(public,nick,
  39                 "For help see http://www.chiark.greenend.org.uk/~matthewv/irc/servus.html")
  40
  41
  42 # query bot status
  43 def infoq(bot, cmd, nick, conn, public, karma):
  44     bot.automsg(public,nick,
  45         ("I am Acrobat %s, on %s, as nick %s.  "+
  46         "My owner is %s; I have karma on %s items.") %
  47         (bot.revision.split()[1], bot.channel, conn.get_nickname(),
  48          bot.owner, len(karma.keys())))
  49
  50 # Check on fish stocks
  51 def fish_quota(pond):
  52     if pond.DoS:
  53         if time.time()>=pond.quotatime:
  54             pond.DoS=0
  55         else:
  56             return
  57     if (time.time()-pond.quotatime)>pond.fish_time_inc:
  58         pond.cur_fish+=(((time.time()-pond.quotatime)
  59                          /pond.fish_time_inc)*pond.fish_inc)
  60         if pond.cur_fish>pond.max_fish:
  61             pond.cur_fish=pond.max_fish
  62         pond.quotatime=time.time()
  63
  64 # trout someone, or flirt with them
  65 def troutq(bot, cmd, nick, conn, public, cfg):
  66     fishlist=cfg[0]
  67     selftrout=cfg[1]
  68     quietmsg=cfg[2]
  69     notargetmsg=cfg[3]
  70     nofishmsg=cfg[4]
  71     fishpond=cfg[5]
  72     selftroutchance=cfg[6]
  73
  74     fish_quota(fishpond)
  75     if fishpond.DoS:
  76         conn.notice(nick, quietmsg%fishpond.Boring_Git)
  77         return
  78     if fishpond.cur_fish<=0:
  79         conn.notice(nick, nofishmsg)
  80         return
  81     target = string.join(cmd.split()[1:])
  82     if len(target)==0:
  83         conn.notice(nick, notargetmsg)
  84         return
  85     me = bot.connection.get_nickname()
  86     trout_msg = random.choice(fishlist)
  87     # The bot won't trout or flirt with itself;
  88     if irc_lower(me) == irc_lower(target):
  89         target = nick
  90     # There's a chance the game may be given away if the request was not
  91     # public...
  92     if not public:
  93         if random.random()<=selftroutchance:
  94             trout_msg=trout_msg+(selftrout%nick)
  95
  96     conn.action(bot.channel, trout_msg % target)
  97     fishpond.cur_fish-=1
  98
  99 # slash a pair
 100 def slashq(bot, cmd, nick, conn, public, cfg):
 101     fishlist=cfg[0]
 102     selfslash=cfg[1]
 103     quietmsg=cfg[2]
 104     notargetmsg=cfg[3]
 105     nofishmsg=cfg[4]
 106     fishpond=cfg[5]
 107     selfslashchance=cfg[6]
 108
 109     fish_quota(fishpond)
 110     if fishpond.DoS:
 111         conn.notice(nick, quietmsg%fishpond.Boring_Git)
 112         return
 113     if fishpond.cur_fish<=0:
 114         conn.notice(nick, nofishmsg)
 115         return
 116     target = string.join(cmd.split()[1:])
 117     #who = cmd.split()[1:]
 118     who = ' '.join(cmd.split()[1:]).split(' / ')
 119     if len(who) < 2:
 120         conn.notice(nick, "it takes two to tango!")
 121         return
 122     elif len(who) > 2:
 123         conn.notice(nick, "we'll have none of that round here")
 124         return
 125     me = bot.connection.get_nickname()
 126     slash_msg = random.choice(fishlist)
 127     # The bot won't slash people with themselves
 128     if irc_lower(who[0]) == irc_lower(who[1]):
 129         conn.notice(nick, "oooooh no missus!")
 130         return
 131     # The bot won't slash with itself, instead slashing the requester
 132     for n in [0,1]:
 133         if irc_lower(me) == irc_lower(who[n]):
 134             who[n] = nick
 135     # Perhaps someone asked to slash themselves with the bot then we get
 136     if irc_lower(who[0]) == irc_lower(who[1]):
 137         conn.notice(nick, "you wish!")
 138         return
 139     # There's a chance the game may be given away if the request was not
 140     # public...
 141     if not public:
 142         if random.random()<=selfslashchance:
 143             slash_msg=slash_msg+(selfslash%nick)
 144
 145     conn.action(bot.channel, slash_msg % (who[0], who[1]))
 146     fishpond.cur_fish-=1
 147
 148 #query units
 149 def unitq(bot, cmd, nick, conn, public):
 150     args = ' '.join(cmd.split()[1:]).split(' as ')
 151     if len(args) != 2:
 152         args = ' '.join(cmd.split()[1:]).split(' / ')
 153         if len(args) != 2:
 154             conn.notice(nick, "syntax: units arg1 as arg2")
 155             return
 156     if args[1]=='?':
 157         sin,sout=os.popen2(["units","--verbose",args[0]],"r")
 158     else:
 159         sin,sout=os.popen2(["units","--verbose",args[0],args[1]],"r")
 160     sin.close()
 161     res=sout.readlines()
 162     #popen2 doesn't clean up the child properly. Do this by hand
 163     child=os.wait()
 164     if os.WEXITSTATUS(child[1])==0:
 165         bot.automsg(public,nick,res[0].strip())
 166     else:
 167         conn.notice(nick,'; '.join(map(lambda x: x.strip(),res)))
 168
 169 # Shut up trouting for a minute
 170 def nofishq(bot, cmd, nick, conn, public, fish):
 171     fish.cur_fish=0
 172     fish.DoS=1
 173     fish.Boring_Git=nick
 174     fish.quotatime=time.time()
 175     fish.quotatime+=fish.nofish_time
 176     conn.notice(nick, "Fish stocks depleted, as you wish.")
 177
 178 # rehash bot config
 179 def reloadq(bot, cmd, nick, conn, public):
 180     if not public and irc_lower(nick) == irc_lower(bot.owner):
 181         try:
 182             reload(bot.config)
 183             conn.notice(nick, "Config reloaded.")
 184         except ImportError:
 185             conn.notice(nick, "Config reloading failed!")
 186     else:
 187         bot.automsg(public,nick,
 188                 "Configuration can only be reloaded by my owner, by /msg.")
 189
 190 # lose the game and/or install a new trigger word
 191 def gameq(bot, cmd, nick, conn, public, game):
 192     #only install a new trigger if it's not too short.
 193     if len(' '.join(cmd.split()[1:]))>2:
 194         game.trigger=' '.join(cmd.split()[1:])
 195     if (time.time()> game.grace):
 196         if not public:
 197             if irc_lower(nick) == irc_lower(bot.owner):
 198                 conn.action(bot.channel,"loses the game!")
 199             else:
 200                 conn.privmsg(bot.channel,nick+" just lost the game!")
 201     else:
 202         if not public:
 203             conn.notice(nick, "It's a grace period!")
 204     game.grace=time.time()+60*20 #20 minutes' grace
 205     game.losetime=time.time()+random.randrange(game.minlose,game.maxlose)
 206     conn.notice(bot.owner, str(game.losetime-time.time())+" "+game.trigger)
 207
 208 # quit irc
 209 def quitq(bot, cmd, nick, conn, public):
 210     if irc_lower(nick) == irc_lower(bot.owner):
 211         bot.die(msg = "I have been chosen!")
 212     elif public:
 213         conn.notice(nick, "Such aggression in public!")
 214     else:
 215         conn.notice(nick, "You're not my owner.")
 216
 217 # google for something
 218 def googleq(bot, cmd, nick, conn, public):
 219     cmdrest = string.join(cmd.split()[1:])
 220     # "I'm Feeling Lucky" rather than try and parse the html
 221     targ = ("http://www.google.com/search?q=%s&btnI=I'm+Feeling+Lucky"
 222             % urllib.quote_plus(cmdrest))
 223     try:
 224         # get redirected and grab the resulting url for returning
 225         gsearch = urllib.urlopen(targ).geturl()
 226         if gsearch != targ: # we've found something
 227             bot.automsg(public,nick,str(gsearch))
 228         else: # we haven't found anything.
 229             bot.automsg(public,nick,"No pages found.")
 230     except IOError: # if the connection times out. This blocks. :(
 231         bot.automsg(public,nick,"The web's broken. Waah!")
 232
 233 # Look up the definition of something using google
 234 def defineq(bot, cmd, nick, conn, public):
 235     cmdrest = string.join(cmd.split()[1:])
 236     targ = ("http://www.google.co.uk/search?q=define%%3A%s&ie=utf-8&oe=utf-8"
 237             % urllib.quote_plus(cmdrest))
 238     try:
 239         # Just slurp everything into a string
 240         defnpage = urllib.urlopen(targ).read()
 241         # For definitions we really do have to parse the HTML, sadly.
 242         # This is of course going to be a bit fragile. We first look for
 243         # 'Definitions of %s on the Web' -- if this isn't present we
 244         # assume we have the 'no definitions found page'.
 245         # The first defn starts after the following <p> tag, but as the
 246         # first <li> in a <ul type="disc" class=std>
 247         # Following that we assume that each definition is all the non-markup
 248         # before a <br> tag. Currently we just dump out the first definition.
 249         match = re.search(r"Definitions of <b>.*?</b> on the Web.*?<li>\s*([^>]*)((<br>)|(<li>))",defnpage,re.MULTILINE)
 250         if match == None:
 251            bot.automsg(public,nick,"Some things defy definition.")
 252         else:
 253            # We assume google has truncated the definition for us so this
 254            # won't flood the channel with text...
 255            defn = " ".join(match.group(1).split("\n"))
 256            bot.automsg(public,nick,defn)
 257     except IOError: # if the connection times out. This blocks. :(
 258          bot.automsg(public,nick,"The web's broken. Waah!")
 259
 260 ### say to msg/channel
 261 def sayq(bot, cmd, nick, conn, public):
 262     if irc_lower(nick) == irc_lower(bot.owner):
 263         conn.privmsg(bot.channel, string.join(cmd.split()[1:]))
 264     else:
 265         if not public:
 266             conn.notice(nick, "You're not my owner!")
 267
 268 ### action to msg/channel
 269 def doq(bot, cmd, nick, conn, public):
 270     sys.stderr.write(irc_lower(bot.owner))
 271     sys.stderr.write(irc_lower(nick))
 272     if not public:
 273         if irc_lower(nick) == irc_lower(bot.owner):
 274             conn.action(bot.channel, string.join(cmd.split()[1:]))
 275         else:
 276             conn.notice(nick, "You're not my owner!")
 277
 278 ###disconnect
 279 def disconnq(bot, cmd, nick, conn, public):
 280     if cmd == "disconnect": # hop off for 60s
 281         bot.disconnect(msg="Be right back.")
 282
 283 ### list keys of a dictionary
 284 def listkeysq(bot, cmd, nick, conn, public, dict, sort=False):
 285     d=dict.keys()
 286     if sort:
 287         d.sort()
 288     bot.automsg(public,nick,string.join(d))
 289
 290 ### rot13 text (yes, I could have typed out the letters....)
 291 ### also "foo".encode('rot13') would have worked
 292 def rot13q(bot, cmd, nick, conn, public):
 293     a=''.join(map(chr,range((ord('a')),(ord('z')+1))))
 294     b=a[13:]+a[:13]
 295     trans=string.maketrans(a+a.upper(),b+b.upper())
 296     conn.notice(nick, string.join(cmd.split()[1:]).translate(trans))
 297
 298 ### URL-tracking stuff
 299
 300 ### return a easy-to-read approximation of a time period
 301 def nicetime(tempus):
 302   if (tempus<120):
 303     tm="%d seconds ago"%int(tempus)
 304   elif (tempus<7200):
 305     tm="%d minutes ago"%int(tempus/60)
 306   if (tempus>7200):
 307     tm="%d hours ago"%int(tempus/3600)
 308   return tm
 309
 310 ### class to store URL data
 311 class UrlLog:
 312     "contains meta-data about a URL seen on-channel"
 313     def __init__(self,url,nick):
 314         self.nick=nick
 315         self.url=url
 316         self.first=time.time()
 317         self.count=1
 318         self.lastseen=time.time()
 319         self.lastasked=time.time()
 320     def recenttime(self):
 321         return max(self.lastseen,self.lastasked)
 322     def firstmen(self):
 323         return nicetime(time.time()-self.first)
 324     def urltype(self):
 325         z=min(len(urlcomplaints)-1, self.count-1)
 326         return urlcomplaints[z]
 327
 328 #(?:) is a regexp that doesn't group
 329 urlre = re.compile("((?:(?:http)|(?:nsfw))s?://[^ ]+)( |$)")
 330 urlcomplaints = ["a contemporary","an interesting","a fascinating","an overused","a vastly overused"]
 331
 332 ### Deal with /msg bot url or ~url in channel
 333 def urlq(bot, cmd, nick, conn, public,urldb):
 334   if (not urlre.search(cmd)):
 335     bot.automsg(False,nick,"Please use 'url' only with http or https URLs")
 336     return
 337
 338   urlstring=urlre.search(cmd).group(1)
 339   url=canonical_url(urlstring)
 340   if (url in urldb):
 341     T = urldb[url]
 342     complaint="That's %s URL that was first mentioned %s by %s" % \
 343                (T.urltype(),T.firstmen(),T.nick)
 344     if (public):
 345       complaint=complaint+". Furthermore it defeats the point of this command to use it other than via /msg."
 346       T.count+=1
 347     bot.automsg(False,nick,complaint)
 348     T.lastasked=time.time()
 349   else:
 350     if (public):
 351       bot.automsg(False,nick,"That URL was unique. There is little point in using !url out loud; please use it via /msg")
 352     else:
 353       if urlstring != cmd.split()[1]: #first argument to URL was not the url
 354         conn.privmsg(bot.channel,"%s remarks: %s" % (nick," ".join(cmd.split()[1:])))
 355       else:
 356         conn.privmsg(bot.channel,"(via %s) %s"%(nick," ".join(cmd.split()[1:])))
 357       bot.automsg(False,nick,"That URL was unique; I have posted it into IRC")
 358     urldb[url]=UrlLog(url,nick)
 359
 360 ### Deal with URLs spotted in channel
 361 def dourl(bot,conn,nick,command,urldb):
 362   urlstring=urlre.search(command).group(1)
 363   urlstring=canonical_url(urlstring)
 364
 365   if urlstring in urldb:
 366     T=urldb[urlstring]
 367     message="observes %s URL, first mentioned %s by %s" % \
 368              (T.urltype(),T.firstmen(),T.nick)
 369     conn.action(bot.channel, message)
 370     T.lastseen=time.time()
 371     T.count+=1
 372   else:
 373     urldb[urlstring]=UrlLog(urlstring,nick)
 374
 375 ### Expire old urls
 376 def urlexpire(urldb,expire):
 377     urls=urldb.keys()
 378     for u in urls:
 379         if time.time() - urldb[u].recenttime() > expire:
 380             del urldb[u]
 381
 382 # canonicalise BBC URLs (internal use only)
 383 def canonical_url(urlstring):
 384   if "nsfw://" in urlstring or "nsfws://" in urlstring:
 385       urlstring=urlstring.replace("nsfw","http",1)
 386   if (urlstring.find("news.bbc.co.uk") != -1):
 387     for middle in ("/low/","/mobile/"):
 388       x = urlstring.find(middle)
 389       if (x != -1):
 390         urlstring.replace(middle,"/hi/")
 391   return urlstring
 392
 393
 394 #get tweet text
 395 def twitterq(bot,cmd,nick,conn,public,twitapi):
 396
 397   if (not urlre.search(cmd)):
 398     bot.automsg(False,nick,"Please use 'twit' only with http URLs")
 399     return
 400
 401   urlstring = urlre.search(cmd).group(1)
 402   if (urlstring.find("twitter.com") !=-1):
 403     stringout = getTweet(urlstring,twitapi)
 404     try:
 405         bot.automsg(public, nick, stringout)
 406     except UnicodeEncodeError:
 407         bot.automsg(public, nick, "Sorry, that tweet contained non-ASCII characters")
 408
 409 def getTweet(urlstring,twitapi):
 410   parts = string.split(urlstring,'/')
 411   tweetID = parts[-1]
 412   try:
 413     status = twitapi.GetStatus(tweetID)
 414     tweeter_screen = status.user.screen_name
 415     tweeter_name = status.user.name
 416     tweetText = status.text
 417     stringout = "tweet by %s (%s): %s" %(tweeter_screen,tweeter_name,tweetText)
 418   except twitter.TwitterError:
 419     terror = sys.exc_info()
 420     stringout = "Twitter error: %s" % terror[1].__str__()
 421   return stringout