chiark / gitweb /
Treat backwards-going timestamp as a day change. Not perfect if the clocks change...
[ypp-sc-tools.main.git] / yoweb-scrape
index 2d96892..cc98ea3 100755 (executable)
@@ -1,5 +1,7 @@
 #!/usr/bin/python
 
+#---------- setup ----------
+
 import signal
 signal.signal(signal.SIGINT, signal.SIG_DFL)
 
@@ -11,12 +13,14 @@ import errno
 import sys
 import re as regexp
 import random
+import curses
 from optparse import OptionParser
 
 from BeautifulSoup import BeautifulSoup
 
 opts = None
 
+#---------- YPP parameters and arrays ----------
 
 puzzles = ('Swordfighting/Bilging/Sailing/Rigging/Navigating'+
        '/Battle Navigation/Gunning/Carpentry/Rumble/Treasure Haul'+
@@ -31,10 +35,20 @@ pirate_ref_re = regexp.compile('^/yoweb/pirate\\.wm')
 max_pirate_namelen = 12
 
 
+#---------- general utilities ----------
+
 def debug(m):
-       if opts.debug:
+       if opts.debug > 0:
                print m
 
+def format_time_interval(ti):
+       if ti < 120: return '%d:%02d' % (ti / 60, ti % 60)
+       if ti < 7200: return '%2dm' % (ti / 60)
+       if ti < 86400: return '%dh' % (ti / 3600)
+       return '%dd' % (ti / 86400)
+
+#---------- caching and rate-limiting data fetcher ----------
+
 class Fetcher:
        def __init__(self, ocean, cachedir):
                debug('Fetcher init %s' % cachedir)
@@ -45,9 +59,9 @@ class Fetcher:
                        if oe.errno != errno.EEXIST: raise
                self._cache_scan(time.time())
 
-       def _default_ocean(self):
+       def default_ocean(self, ocean='ice'):
                if self.ocean is None:
-                       self.ocean = 'ice'
+                       self.ocean = ocean
 
        def _cache_scan(self, now):
                # returns list of ages, unsorted
@@ -128,11 +142,13 @@ class Fetcher:
                return data
 
        def yoweb(self, kind, tail, max_age):
-               self._default_ocean()
+               self.default_ocean()
                url = 'http://%s.puzzlepirates.com/yoweb/%s%s' % (
                        self.ocean, kind, tail)
                return self.fetch(url, max_age)
 
+#---------- logging assistance for troubled screenscrapers ----------
+
 class SoupLog:
        def __init__(self):
                self.msgs = [ ]
@@ -156,6 +172,8 @@ class SomethingSoupInfo(SoupLog):
                        convertEntities=BeautifulSoup.HTML_ENTITIES
                        )
 
+#---------- scraper for pirate pages ----------
+
 class PirateInfo(SomethingSoupInfo):
        # Public data members:
        #  pi.standings = { 'Treasure Haul': 'Able' ... }
@@ -255,6 +273,8 @@ u'\\s*\\S*/([-A-Za-z]+)\\s*$|\\s*\\S*/\\S*\\s*\\(ocean\\-wide(?:\\s|\\xa0)+([-A-
        def __str__(self):
                return `(self.crew, self.flag, self.standings, self.msgs)`
 
+#---------- scraper for crew pages ----------
+
 class CrewInfo(SomethingSoupInfo):
        # Public data members:
        #  ci.crew = [ ('Captain',        ['Pirate', ...]),
@@ -303,6 +323,8 @@ class CrewInfo(SomethingSoupInfo):
        def __str__(self):
                return `(self.crew, self.msgs)`
 
+#---------- pretty-printer for tables of pirate puzzle standings ----------
+
 class StandingsTable:
        def __init__(self, use_puzzles=None, col_width=6):
                if use_puzzles is None:
@@ -321,17 +343,18 @@ class StandingsTable:
                self.s = ''
                self._cw = col_width-1
 
-       def _pline(self, pirate, puzstrs):
+       def _pline(self, pirate, puzstrs, extra):
                self.s += ' %-*s' % (max(max_pirate_namelen, 14), pirate)
                for v in puzstrs:
                        self.s += ' %-*.*s' % (self._cw,self._cw, v)
+               if extra:
+                       self.s += ' ' + extra
                self.s += '\n'
 
        def _puzstr(self, pi, puzzle):
                if not isinstance(puzzle,list): puzzle = [puzzle]
                try: standing = max([pi.standings[p] for p in puzzle])
                except KeyError: return '?'
-               if isinstance(standing,basestring): return standing
                if not standing: return ''
                s = ''
                if self._cw > 4:
@@ -353,55 +376,33 @@ class StandingsTable:
                        spc = name.find(' ')
                        if spc < 0: return name
                        return name[0:min(4,spc)] + name[spc+1:]
-               self._pline('', map(puzn_redact, self._puzzles))
+               self._pline('', map(puzn_redact, self._puzzles), None)
        def literalline(self, line):
                self.s += line + '\n'
-       def pirate(self, pi):
+       def pirate_dummy(self, name, standingstring, extra=None):
+               self._pline(name, standingstring * len(self._puzzles), extra)
+       def pirate(self, pi, extra=None):
                puzstrs = [self._puzstr(pi,puz) for puz in self._puzzles]
-               self._pline(pi.name, puzstrs)
+               self._pline(pi.name, puzstrs, extra)
 
        def results(self):
                return self.s
 
-def do_pirate(pirates, bu):
-       print '{'
-       for pirate in pirates:
-               info = PirateInfo(pirate)
-               print '%s: %s,' % (`pirate`, info)
-       print '}'
-
-def prep_crew_of(args, bu, max_age=300):
-       if len(args) != 1: bu('crew-of takes one pirate name')
-       pi = PirateInfo(args[0], max_age)
-       return CrewInfo(pi.crew[0], max_age)
-
-def do_crew_of(args, bu):
-       ci = prep_crew_of(args, bu)
-       print ci
-
-def do_standings_crew_of(args, bu):
-       ci = prep_crew_of(args, bu, 60)
-       tab = StandingsTable()
-       tab.headings()
-       for (rank, members) in ci.crew:
-               if not members: continue
-               tab.literalline('%s:' % rank)
-               for p in members:
-                       pi = PirateInfo(p, random.randint(900,1800))
-                       tab.pirate(pi)
-       print tab.results()
+#---------- chat log parser ----------
 
 class PirateAboard:
-       # pa.v
-       # pa.last_time
-       # pa.last_event
-       # pa.gunner
-       # pa.last_chat_time
-       # pa.last_chat_chan
-       # pa.pi
+       # This is essentially a transparent, dumb, data class.
+       #  pa.v
+       #  pa.name
+       #  pa.last_time
+       #  pa.last_event
+       #  pa.gunner
+       #  pa.last_chat_time
+       #  pa.last_chat_chan
+       #  pa.pi
 
        def __init__(pa, pn, v, time, event):
-               pa.pn = pn
+               pa.name = pn
                pa.v = v
                pa.last_time = time
                pa.last_event = event
@@ -410,12 +411,15 @@ class PirateAboard:
                pa.gunner = False
                pa.pi = None
 
-       def pirate_info(self):
-               if not pa.pi and not fetcher.need_wait(time.time):
+       def pirate_info(pa):
+               if not pa.pi and not fetcher.need_wait(time.time()):
                        pa.pi = PirateInfo(pa.name, 3600)
                return pa.pi
 
 class ChatLogTracker:
+       # This is quite complex so we make it opaque.  Use the
+       # official invokers, accessors etc.
+
        def __init__(self, myself_pi, logfn):
                self._pl = {}   # self._pl['Pirate'] =
                self._vl = {}   #   self._vl['Vessel']['Pirate'] = PirateAboard
@@ -424,13 +428,13 @@ class ChatLogTracker:
                self._vessel = None     #       self._vl[self._vessel]
                self._date = None
                self._myself = myself_pi
-               self.need_redisplay = False
+               self._need_redisplay = False
                self._f = file(logfn)
                self._lbuf = ''
                self._progress = [0, os.fstat(self._f.fileno()).st_size]
 
-       def _refresh(self):
-               self.need_redisplay = True
+       def force_redisplay(self):
+               self._need_redisplay = True
 
        def _onboard_event(self,timestamp,pirate,event):
                try: pa = self._pl[pirate]
@@ -444,14 +448,14 @@ class ChatLogTracker:
                        self._pl[pirate] = pa
                        self._v[pirate] = pa
                self._v['#lastaboard'] = timestamp
-               self._refresh()
+               self.force_redisplay()
                return pa
 
        def _trash_vessel(self, v):
                for pn in v:
                        if pn.startswith('#'): continue
                        del self._pl[pn]
-               self._refresh()
+               self.force_redisplay()
 
        def expire_garbage(self, timestamp):
                for (vn,v) in list(self._vl.iteritems()):
@@ -478,7 +482,8 @@ class ChatLogTracker:
 
                m = rm('=+ (\\d+)/(\\d+)/(\\d+) =+$')
                if m:
-                       self._date = m.groups()
+                       self._date = [int(x) for x in m.groups()]
+                       self._previous_timestamp = None
                        return d('date '+`self._date`)
 
                if self._date is None:
@@ -488,9 +493,18 @@ class ChatLogTracker:
                if not m:
                        return d('no timestamp')
 
-               time_tuple = [int(x) for x in self._date + m.groups()]
-               time_tuple += (-1,-1,-1)
-               timestamp = time.mktime(time_tuple)
+               while True:
+                       time_tuple = (self._date +
+                                     [int(x) for x in m.groups()] +
+                                     [-1,-1,-1])
+                       timestamp = time.mktime(time_tuple)
+                       if timestamp >= self._previous_timestamp: break
+                       self._date[2] += 1
+                       self._debug_line_disposition(timestamp,'',
+                               'new date '+`self._date`)
+
+               self._previous_timestamp = timestamp
+
                l = l[l.find(' ')+1:]
 
                def ob_x(who,event):
@@ -527,13 +541,13 @@ class ChatLogTracker:
                m = rm('You have ordered (\\w+) to do some (\\S.*\\S)\\.$')
                if m:
                        (who,what) = m.groups()
-                       pa = ob_x(who,'ordered '+what)
+                       pa = ob_x(who,'ord '+what)
                        if what == 'Gunning':
                                pa.gunner = True
                        return d('duty order')
 
                m = rm('(\\w+) abandoned a (\\S.*\\S) station\\.$')
-               if m: oba('stopped'); return d('stopped')
+               if m: oba('stopped'); return d("end")
 
                def chat(what):
                        who = m.group(1)
@@ -542,7 +556,7 @@ class ChatLogTracker:
                        if pa.v is self._v:
                                pa.last_chat_time = timestamp
                                pa.last_chat_chan = what
-                               self._refresh()
+                               self.force_redisplay()
                                return d(what+' chat')
 
                m = rm('(\\w+) (?:issued an order|ordered everyone) "')
@@ -633,41 +647,215 @@ class ChatLogTracker:
                                self._lbuf = ''
                if progress: progress.caughtup()
 
+       def changed(self):
+               rv = self._need_redisplay
+               self._need_redisplay = False
+               return rv
+       def myname(self):
+               # returns our pirate name
+               return self._myself.name
+       def vessel(self):
+               # returns the vessel we're aboard or None
+               return self._vessel
+       def aboard(self):
+               # returns a list of PirateAboard sorted by name
+               if self._v is None: return []
+               return [ self._v[pn]
+                        for pn in sorted(self._v.keys())
+                        if not pn.startswith('#') ]
+
+#---------- implementations of actual operation modes ----------
+
+def do_pirate(pirates, bu):
+       print '{'
+       for pirate in pirates:
+               info = PirateInfo(pirate)
+               print '%s: %s,' % (`pirate`, info)
+       print '}'
+
+def prep_crew_of(args, bu, max_age=300):
+       if len(args) != 1: bu('crew-of takes one pirate name')
+       pi = PirateInfo(args[0], max_age)
+       if pi.crew is None: return None
+       return CrewInfo(pi.crew[0], max_age)
+
+def do_crew_of(args, bu):
+       ci = prep_crew_of(args, bu)
+       print ci
+
+def do_standings_crew_of(args, bu):
+       ci = prep_crew_of(args, bu, 60)
+       tab = StandingsTable()
+       tab.headings()
+       for (rank, members) in ci.crew:
+               if not members: continue
+               tab.literalline('%s:' % rank)
+               for p in members:
+                       pi = PirateInfo(p, random.randint(900,1800))
+                       tab.pirate(pi)
+       print tab.results()
+
 class ProgressPrintPercentage:
-       def __init__(self, f=sys.stdout): self._f = f
-       def progress(self,done,total):
-               self._f.write("scan chat logs %3d%%\r" % ((done*100) / total))
+       def __init__(self, f=sys.stdout):
+               self._f = f
+       def progress_string(self,done,total):
+               return "scan chat logs %3d%%\r" % ((done*100) / total)
+       def progress(self,*a):
+               self._f.write(self.progress_string(*a))
                self._f.flush()
+       def show_init(self, pirate, ocean):
+               print >>self._f, 'Starting up, %s on the %s ocean' % (
+                       pirate, ocean)
        def caughtup(self):
                self._f.write('                   \r')
                self._f.flush()
 
-def simple_printer(x): print x
+#----- modes which use the chat log parser are quite complex -----
 
-def run_chat_log(args, bu, progress=ProgressPrintPercentage(),
-               display=simple_printer, max_myself_age=3600):
+def prep_chat_log(args, bu,
+               progress=ProgressPrintPercentage(),
+               max_myself_age=3600):
        if len(args) != 1: bu('this action takes only chat log filename')
        logfn = args[0]
-       logfn_re = '(?:.*/)?([A-Z][a-z]+)_([a-z]+)_chat-log-\\w+$'
+       logfn_re = '(?:.*/)?([A-Z][a-z]+)_([a-z]+)_'
        match = regexp.match(logfn_re, logfn)
-       if not match: bu('chat log filename is not in default format')
-       (pirate, fetcher.ocean) = match.groups()
+       if not match: bu('chat log filename is not in expected format')
+       (pirate, ocean) = match.groups()
+       fetcher.default_ocean(ocean)
        
-       myself_pi = PirateInfo(pirate,max_myself_age)
-       track = ChatLogTracker(myself_pi, logfn)
+       myself = PirateInfo(pirate,max_myself_age)
+       progress.show_init(pirate, fetcher.ocean)
+       track = ChatLogTracker(myself, logfn)
 
+       opts.debug -= 1
        track.catchup(progress)
+       opts.debug += 1
+
+       track.force_redisplay()
+
+       return (myself, track)
+
+def do_track_chat_log(args, bu):
+       (myself, track) = prep_chat_log(args, bu)
        while True:
                track.catchup()
-               if track.need_redisplay:
-                       display(track)
-                       track.need_redisplay = False
+               if track.changed():
+                       print track
                time.sleep(1)
 
-def do_track_chat_log(args, bu):
-       run_chat_log(args, bu)
+#----- ship management aid -----
+
+class Display_dumb(ProgressPrintPercentage):
+       def __init__(self):
+               ProgressPrintPercentage.__init__(self)
+       def show(self, s):
+               print '\n\n', s;
+       def realstart(self):
+               pass
+
+class Display_overwrite(ProgressPrintPercentage):
+       def __init__(self):
+               ProgressPrintPercentage.__init__(self)
+
+               null = file('/dev/null','w')
+               curses.setupterm(fd=null.fileno())
+
+               self._clear = curses.tigetstr('clear')
+               if not self._clear:
+                       self._debug('missing clear!')
+                       self.show = Display_dumb.show
+                       return
+
+               self._t = {'el':'', 'ed':''}
+               if not self._init_sophisticated():
+                       for k in self._t.keys(): self._t[k] = ''
+                       self._t['ho'] = self._clear
+
+       def _debug(self,m): debug('display overwrite: '+m)
+
+       def _init_sophisticated(self):
+               for k in self._t.keys():
+                       s = curses.tigetstr(k)
+                       self._t[k] = s
+               self._t['ho'] = curses.tigetstr('ho')
+               if not self._t['ho']:
+                       cup = curses.tigetstr('cup')
+                       self._t['ho'] = curses.tparm(cup,0,0)
+               missing = [k for k in self._t.keys() if not self._t[k]]
+               if missing:
+                       self.debug('missing '+(' '.join(missing)))
+                       return 0
+               return 1
+
+       def show(self, s):
+               w = sys.stdout.write
+               def wti(k): w(self._t[k])
+
+               wti('ho')
+               nl = ''
+               for l in s.rstrip().split('\n'):
+                       w(nl)
+                       w(l)
+                       wti('el')
+                       nl = '\r\n'
+               wti('ed')
+               w(' ')
+               sys.stdout.flush()
+
+       def realstart(self):
+               sys.stdout.write(self._clear)
+               sys.stdout.flush()
+                       
+
+def do_ship_aid(args, bu):
+       if opts.ship_duty is None: opts.ship_duty = True
+
+       displayer = globals()['Display_'+opts.display]()
+       rotate_nya = '/-\\'
+
+       (myself, track) = prep_chat_log(args, bu, progress=displayer)
+
+       def timeevent(t,e):
+               if t is None: return ' ' * 22
+               return " %-4s %-16s" % (format_time_interval(now - t),e)
+
+       displayer.realstart()
+
+       while True:
+               track.catchup()
+               now = time.time()
+
+               s = "%s" % track.myname()
 
-#def do_ship_aid(args, bu):
+               vn = track.vessel()
+               if vn is None: s += " not on a vessel?!"
+               else: s += " on board the %s" % vn
+               s += " at %s\n" % time.strftime("%Y-%m-%d %H:%M:%S")
+
+               tbl = StandingsTable()
+               tbl.headings()
+
+               for pa in track.aboard():
+                       pi = pa.pirate_info()
+
+                       xs = ''
+                       if pa.gunner: xs += 'G '
+                       else: xs += '  '
+                       xs += timeevent(pa.last_time, pa.last_event)
+                       xs += timeevent(pa.last_chat_time, pa.last_chat_chan)
+
+                       if pi is None:
+                               tbl.pirate_dummy(pa.name, rotate_nya[0], xs)
+                       else:
+                               tbl.pirate(pi, xs)
+
+               s += tbl.results()
+
+               displayer.show(s)
+               time.sleep(1)
+               rotate_nya = rotate_nya[1:2] + rotate_nya[0]
+
+#---------- main program ----------
 
 def main():
        global opts, fetcher
@@ -679,7 +867,11 @@ actions:
  yoweb-scrape [--ocean OCEAN ...] crew-of PIRATE
  yoweb-scrape [--ocean OCEAN ...] standings-crew-of PIRATE
  yoweb-scrape [--ocean OCEAN ...] track-chat-log CHAT-LOG
- yoweb-scrape [--ocean OCEAN ...] ship-aid CHAT-LOG
+ yoweb-scrape [options] ship-aid CHAT-LOG  (must be .../PIRATE_OCEAN_chat-log*)
+
+display modes (for --display) apply to ship-aid:
+ --display=dumb       just print new information, scrolling the screen
+ --display=overwrite  use cursor motion, selective clear, etc. to redraw at top
 ''')
        ao = pa.add_option
        ao('-O','--ocean',dest='ocean', metavar='OCEAN', default=None,
@@ -687,10 +879,15 @@ actions:
        ao('--cache-dir', dest='cache_dir', metavar='DIR',
                default='~/.yoweb-scrape-cache',
                help='cache yoweb pages in DIR')
-       ao('-D','--debug', action='store_true', dest='debug', default=False,
+       ao('-D','--debug', action='count', dest='debug', default=0,
                help='enable debugging output')
+       ao('--debug-fd', action='count', dest='debug_fd',
+               help='write any debugging output to specified fd')
        ao('-q','--quiet', action='store_true', dest='quiet',
                help='suppress warning output')
+       ao('--display', action='store', dest='display',
+               type='choice', choices=['dumb','overwrite'],
+               help='how to display ship aid')
 
        ao('--ship-duty', action='store_true', dest='ship_duty',
                help='show ship duty station puzzles')
@@ -703,6 +900,9 @@ actions:
        if len(args) < 1:
                pa.error('need a mode argument')
 
+       if opts.debug_fd is not None:
+               opts.debug_file = fdopen(opts.debug_fd, 'w')
+
        mode = args[0]
        mode_fn_name = 'do_' + mode.replace('_','#').replace('-','_')
        try: mode_fn = globals()[mode_fn_name]
@@ -716,6 +916,13 @@ actions:
        if opts.cache_dir.startswith('~/'):
                opts.cache_dir = os.getenv('HOME') + opts.cache_dir[1:]
 
+       if opts.display is None:
+               if ((opts.debug > 0 and opts.debug_fd is None)
+                   or not os.isatty(sys.stdout.fileno())):
+                       opts.display = 'dumb'
+               else:
+                       opts.display = 'overwrite'
+
        fetcher = Fetcher(opts.ocean, opts.cache_dir)
 
        mode_fn(args[1:], pa.error)