chiark / gitweb /
update .gitignore for new filenames
[ypp-sc-tools.web-live.git] / yoweb-scrape
index d2d194c..8f0bf56 100755 (executable)
@@ -1,4 +1,32 @@
 #!/usr/bin/python
+# This is part of ypp-sc-tools, a set of third-party tools for assisting
+# players of Yohoho Puzzle Pirates.
+#
+# Copyright (C) 2009 Ian Jackson <ijackson@chiark.greenend.org.uk>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+# Yohoho and Puzzle Pirates are probably trademarks of Three Rings and
+# are used without permission.  This program is not endorsed or
+# sponsored by Three Rings.
+
+copyright_info = '''
+yoweb-scrape is part of ypp-sc-tools  Copyright (C) 2009 Ian Jackson
+This program comes with ABSOLUTELY NO WARRANTY; this is free software,
+and you are welcome to redistribute it under certain conditions.
+For details, read the top of the yoweb-scrape file.
+'''
 
 #---------- setup ----------
 
@@ -16,6 +44,7 @@ import random
 import curses
 import termios
 from optparse import OptionParser
+from StringIO import StringIO
 
 from BeautifulSoup import BeautifulSoup
 
@@ -348,23 +377,33 @@ class CrewInfo(SomethingSoupInfo):
 #---------- pretty-printer for tables of pirate puzzle standings ----------
 
 class StandingsTable:
-       def __init__(self, use_puzzles=None, col_width=6):
+       def __init__(self, f, use_puzzles=None, col_width=6, gap_every=5):
                if use_puzzles is None:
                        if opts.ship_duty:
                                use_puzzles=duty_puzzles
                        else:
                                use_puzzles=puzzles
                self._puzzles = use_puzzles
-               self.s = ''
+               self.f = f
                self._cw = col_width-1
+               self._gap_every = gap_every
+               self._linecount = 0
+               self._o = f.write
+
+       def _nl(self): self._o('\n')
 
        def _pline(self, pirate, puzstrs, extra):
-               self.s += ' %-*s' % (max(max_pirate_namelen, 14), pirate)
+               if (self._linecount > 0
+                   and self._gap_every is not None
+                   and not (self._linecount % self._gap_every)):
+                       self._nl()
+               self._o(' %-*s' % (max(max_pirate_namelen, 14), pirate))
                for v in puzstrs:
-                       self.s += ' %-*.*s' % (self._cw,self._cw, v)
+                       self._o(' %-*.*s' % (self._cw,self._cw, v))
                if extra:
-                       self.s += ' ' + extra
-               self.s += '\n'
+                       self._o(' ' + extra)
+               self._nl()
+               self._linecount += 1
 
        def _puzstr(self, pi, puzzle):
                if not isinstance(puzzle,list): puzzle = [puzzle]
@@ -382,7 +421,7 @@ class StandingsTable:
                s += '+' * (standing % 2)
                return s
 
-       def headings(self):
+       def headings(self, lhs='', rhs=None):
                def puzn_redact(name):
                        if isinstance(name,list):
                                return '/'.join(
@@ -391,17 +430,19 @@ 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), None)
+               self._linecount = -2
+               self._pline(lhs, map(puzn_redact, self._puzzles), rhs)
+               self._linecount = 0
        def literalline(self, line):
-               self.s += line + '\n'
+               self._o(line)
+               self._nl()
+               self._linecount = 0
        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, extra)
 
-       def results(self):
-               return self.s
 
 #---------- chat log parser ----------
 
@@ -874,15 +915,15 @@ def do_crew_of(args, bu):
 
 def do_standings_crew_of(args, bu):
        ci = prep_crew_of(args, bu, 60)
-       tab = StandingsTable()
+       tab = StandingsTable(sys.stdout)
        tab.headings()
        for (rank, members) in ci.crew:
                if not members: continue
+               tab.literalline('')
                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):
@@ -1017,12 +1058,15 @@ def do_ship_aid(args, bu):
 
 class KeyBasedSorter:
        def compar_key_pa(self, pa):
-               return self.compar_key(pa.pirate_info())
+               pi = pa.pirate_info()
+               if pi is None: return None
+               return self.compar_key(pi)
        def lsort_pa(self, l):
                l.sort(key = self.compar_key_pa)
 
 class NameSorter(KeyBasedSorter):
        def compar_key(self, pi): return pi.name
+       def desc(self): return 'name'
 
 class SkillSorter(NameSorter):
        def __init__(self, relevant):
@@ -1032,7 +1076,10 @@ class SkillSorter(NameSorter):
                        if isinstance(p,basestring): self._avoid.add(p)
                        else: self._avoid |= set(p)
                self._avoid -= self._want
+               self._desc = '%s' % relevant
        
+       def desc(self): return self._desc
+
        def compar_key(self, pi):
                best_want = max([
                        pi.standings.get(puz,-1)
@@ -1077,13 +1124,17 @@ def ship_aid_core(myself, track, displayer, kreader):
                s += kreader.info()
                s += '\n'
 
-               tbl = StandingsTable()
-               tbl.headings()
-
                aboard = track.aboard(vn)
-
                sort.lsort_pa(aboard)
 
+               tbl_s = StringIO()
+               tbl = StandingsTable(tbl_s)
+
+               if track.vesselname(): howmany = ' %d aboard' % len(aboard)
+               else: howmany = ''
+
+               tbl.headings(howmany, '  sorted by '+sort.desc())
+
                for pa in aboard:
                        pi = pa.pirate_info()
 
@@ -1098,8 +1149,9 @@ def ship_aid_core(myself, track, displayer, kreader):
                        else:
                                tbl.pirate(pi, xs)
 
-               s += tbl.results()
+               s += tbl_s.getvalue()
                displayer.show(s)
+               tbl_s.close()
 
                k = kreader.getch()
                if k is None:
@@ -1161,8 +1213,7 @@ actions:
 
 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
-''')
+ --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,
                help='select ocean OCEAN')
@@ -1184,10 +1235,15 @@ display modes (for --display) apply to ship-aid:
        ao('--all-puzzles', action='store_false', dest='ship_duty',
                help='show all puzzles, not just ship duty stations')
 
+       ao('--min-cache-reuse', type='int', dest='min_max_age',
+               metavar='SECONDS', default=60,
+               help='always reuse cache yoweb data if no older than this')
+
        (opts,args) = pa.parse_args()
        random.seed()
 
        if len(args) < 1:
+               print >>sys.stderr, copyright_info
                pa.error('need a mode argument')
 
        if opts.debug_fd is not None:
@@ -1201,8 +1257,8 @@ display modes (for --display) apply to ship-aid:
        except KeyError: pa.error('unknown mode "%s"' % mode)
 
        # fixed parameters
-       opts.min_max_age = 60
-       opts.expire_age = 3600
+       opts.expire_age = max(3600, opts.min_max_age)
+
        opts.ship_reboard_clearout = 3600
 
        if opts.cache_dir.startswith('~/'):