X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~yarrgweb/git?p=ypp-sc-tools.main.git;a=blobdiff_plain;f=yoweb-scrape;h=2a3559009ef23e941e17bed9fc35298634251c4d;hp=9d8f69dd0f8cd9bb96cbccc5ec7faa35437e1bd5;hb=6024b8b7e54143104a1f29d3976c5194c889f5ba;hpb=82fe9647121ac3d86f84208152a65177f4f8b335 diff --git a/yoweb-scrape b/yoweb-scrape index 9d8f69d..2a35590 100755 --- a/yoweb-scrape +++ b/yoweb-scrape @@ -1,5 +1,7 @@ #!/usr/bin/python +#---------- setup ---------- + import signal signal.signal(signal.SIGINT, signal.SIG_DFL) @@ -17,6 +19,7 @@ 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 +34,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) @@ -70,7 +83,7 @@ class Fetcher: ages.append(age) return ages - def _rate_limit_cache_clean(self, now): + def need_wait(self, now): ages = self._cache_scan(now) ages.sort() debug('Fetcher ages ' + `ages`) @@ -83,6 +96,10 @@ class Fetcher: need_wait = max(need_wait, min_age - age) min_age += 3 min_age *= 1.25 + return need_wait + + def _rate_limit_cache_clean(self, now): + need_wait = self.need_wait(now) if need_wait > 0: debug('Fetcher wait %d' % need_wait) time.sleep(need_wait) @@ -129,6 +146,8 @@ class Fetcher: self.ocean, kind, tail) return self.fetch(url, max_age) +#---------- logging assistance for troubled screenscrapers ---------- + class SoupLog: def __init__(self): self.msgs = [ ] @@ -152,6 +171,8 @@ class SomethingSoupInfo(SoupLog): convertEntities=BeautifulSoup.HTML_ENTITIES ) +#---------- scraper for pirate pages ---------- + class PirateInfo(SomethingSoupInfo): # Public data members: # pi.standings = { 'Treasure Haul': 'Able' ... } @@ -251,6 +272,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', ...]), @@ -280,7 +303,7 @@ class CrewInfo(SomethingSoupInfo): crew_rank_re = regexp.compile('/yoweb/images/crew') for row in tbl.contents: # findAll(recurse=False) - if isinstance(row, unicode): + if isinstance(row,basestring): continue is_rank = row.find('img', attrs={'src': crew_rank_re}) @@ -299,6 +322,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: @@ -317,10 +342,12 @@ 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): @@ -348,61 +375,51 @@ 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 - def __init__(pa, v, time, event): + # 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.name = pn pa.v = v pa.last_time = time pa.last_event = event pa.last_chat_time = None pa.last_chat_chan = None pa.gunner = False + pa.pi = None + + 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: - def __init__(self, myself_pi): + # 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 # self._vl['Vessel']['#lastaboard'] @@ -411,6 +428,9 @@ class ChatLogTracker: self._date = None self._myself = myself_pi 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 @@ -423,7 +443,7 @@ class ChatLogTracker: pa.last_event = event else: if pa is not None: del pa.v[pirate] - pa = PirateAboard(self._v, timestamp, event) + pa = PirateAboard(pirate, self._v, timestamp, event) self._pl[pirate] = pa self._v[pirate] = pa self._v['#lastaboard'] = timestamp @@ -434,6 +454,7 @@ class ChatLogTracker: for pn in v: if pn.startswith('#'): continue del self._pl[pn] + self._refresh() def expire_garbage(self, timestamp): for (vn,v) in list(self._vl.iteritems()): @@ -509,13 +530,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) @@ -601,28 +622,165 @@ class ChatLogTracker: s += '>\n' return s -def do_ship_aid(args, bu): - if len(args) != 1: bu('ship-aid takes only chat log filename') + def catchup(self, progress=None): + while True: + more = self._f.readline() + if not more: break + + self._progress[0] += len(more) + if progress: progress.progress(*self._progress) + + self._lbuf += more + if self._lbuf.endswith('\n'): + self.chatline(self._lbuf.rstrip()) + 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 + 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_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 caughtup(self): + self._f.write(' \r') + self._f.flush() + +#----- modes which use the chat log parser are quite complex ----- + +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+$' match = regexp.match(logfn_re, logfn) - if not match: bu('ship-aid chat log filename is not in default format') + if not match: bu('chat log filename is not in default format') (pirate, fetcher.ocean) = match.groups() - myself_pi = PirateInfo(pirate,3600) - track = ChatLogTracker(myself_pi) - f = file(logfn) - l = '' + + myself = PirateInfo(pirate,max_myself_age) + track = ChatLogTracker(myself, logfn) + + opts.debug -= 1 + track.catchup(progress) + opts.debug += 1 + + return (myself, track) + +def do_track_chat_log(args, bu): + (myself, track) = prep_chat_log(args, bu) while True: - l += f.readline() - if l.endswith('\n'): - track.chatline(l.rstrip()) - l = '' + track.catchup() + if track.changed(): print track - continue - if l: - continue - print track - os.sleep(1) + time.sleep(1) + +#----- ship management aid ----- + +class Display_dumb(ProgressPrintPercentage): + def __init__(self): + ProgressPrintPercentage.__init__(self) + def show(self, s): + print '\n\n', s; + +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) + + while True: + track.catchup() + now = time.time() + + s = "%s" % track.myname() + + vn = track.vessel() + if vn is None: + s += " not on a vessel?!" + else: + s += " on board the %s at %s\n" % ( + vn, 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 @@ -633,7 +791,12 @@ actions: yoweb-scrape [--ocean OCEAN ...] pirate PIRATE yoweb-scrape [--ocean OCEAN ...] crew-of PIRATE yoweb-scrape [--ocean OCEAN ...] standings-crew-of PIRATE - yoweb-scrape [--ocean OCEAN ...] ship-aid CHAT-LOG + yoweb-scrape [--ocean OCEAN ...] track-chat-log 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, @@ -641,13 +804,20 @@ 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') + ao('--all-puzzles', action='store_false', dest='ship_duty', + help='show all puzzles, not just ship duty stations') (opts,args) = pa.parse_args() random.seed() @@ -655,6 +825,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] @@ -668,6 +841,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)