2 # This is part of ypp-sc-tools, a set of third-party tools for assisting
3 # players of Yohoho Puzzle Pirates.
5 # Copyright (C) 2009 Ian Jackson <ijackson@chiark.greenend.org.uk>
7 # This program is free software: you can redistribute it and/or modify
8 # it under the terms of the GNU General Public License as published by
9 # the Free Software Foundation, either version 3 of the License, or
10 # (at your option) any later version.
12 # This program is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
20 # Yohoho and Puzzle Pirates are probably trademarks of Three Rings and
21 # are used without permission. This program is not endorsed or
22 # sponsored by Three Rings.
25 yoweb-scrape is part of ypp-sc-tools Copyright (C) 2009 Ian Jackson
26 This program comes with ABSOLUTELY NO WARRANTY; this is free software,
27 and you are welcome to redistribute it under certain conditions.
28 For details, read the top of the yoweb-scrape file.
31 #---------- setup ----------
34 signal.signal(signal.SIGINT, signal.SIG_DFL)
48 from optparse import OptionParser
49 from StringIO import StringIO
51 from BeautifulSoup import BeautifulSoup
55 #---------- YPP parameters and arrays ----------
57 puzzles = ('Swordfighting/Bilging/Sailing/Rigging/Navigating'+
58 '/Battle Navigation/Gunning/Carpentry/Rumble/Treasure Haul'+
59 '/Drinking/Spades/Hearts/Treasure Drop/Poker/Distilling'+
60 '/Alchemistry/Shipwrightery/Blacksmithing/Foraging').split('/')
64 ['Sailing','Rigging'],
69 duty_puzzles = ([ 'Navigating', 'Battle Navigation' ] +
73 standingvals = ('Able/Proficient/Distinguished/Respected/Master'+
74 '/Renowned/Grand-Master/Legendary/Ultimate').split('/')
75 standing_limit = len(standingvals)
77 pirate_ref_re = regexp.compile('^/yoweb/pirate\\.wm')
79 max_pirate_namelen = 12
82 #---------- general utilities ----------
86 print >>opts.debug_file, m
90 opts.debug_file.flush()
96 def format_time_interval(ti):
97 if ti < 120: return '%d:%02d' % (ti / 60, ti % 60)
98 if ti < 7200: return '%2dm' % (ti / 60)
99 if ti < 86400: return '%dh' % (ti / 3600)
100 return '%dd' % (ti / 86400)
103 lib = os.getenv("YPPSC_YARRG_SRCBASE")
104 if lib is not None: return lib
106 lib = regexp.sub('/[^/]+$', '', lib)
107 os.environ["YPPSC_YARRG_SRCBASE"] = lib
110 #---------- caching and rate-limiting data fetcher ----------
113 def __init__(self, ocean, cachedir):
114 debug('Fetcher init %s' % cachedir)
116 self.cachedir = cachedir
117 try: os.mkdir(cachedir)
118 except (OSError,IOError), oe:
119 if oe.errno != errno.EEXIST: raise
120 self._cache_scan(time.time())
122 def default_ocean(self, ocean='ice'):
123 if self.ocean is None:
126 def _cache_scan(self, now):
127 # returns list of ages, unsorted
129 debug('Fetcher scan_cache')
130 for leaf in os.listdir(self.cachedir):
131 if not leaf.startswith('#'): continue
132 path = self.cachedir + '/' + leaf
133 try: s = os.stat(path)
134 except (OSError,IOError), oe:
135 if oe.errno != errno.ENOENT: raise
137 age = now - s.st_mtime
138 if age > opts.expire_age:
139 debug('Fetcher expire %d %s' % (age, path))
141 except (OSError,IOError), oe:
142 if oe.errno != errno.ENOENT: raise
147 def need_wait(self, now, imaginary=[]):
148 ages = self._cache_scan(now)
151 debug('Fetcher ages ' + `ages`)
155 if age < min_age and age <= 5:
156 debug('Fetcher morewait min=%d age=%d' %
158 need_wait = max(need_wait, min_age - age)
162 need_wait += random.random() - 0.5
165 def _rate_limit_cache_clean(self, now):
166 need_wait = self.need_wait(now)
168 debug('Fetcher wait %d' % need_wait)
171 def fetch(self, url, max_age):
172 debug('Fetcher fetch %s' % url)
173 cache_corename = urllib.quote_plus(url)
174 cache_item = "%s/#%s#" % (self.cachedir, cache_corename)
175 try: f = file(cache_item, 'r')
176 except (OSError,IOError), oe:
177 if oe.errno != errno.ENOENT: raise
180 max_age = max(opts.min_max_age, min(max_age, opts.expire_age))
182 s = os.fstat(f.fileno())
183 age = now - s.st_mtime
185 debug('Fetcher stale %d < %d'% (max_age, age))
190 debug('Fetcher cached %d > %d' % (max_age, age))
193 debug('Fetcher fetch')
194 self._rate_limit_cache_clean(now)
196 stream = urllib2.urlopen(url)
198 cache_tmp = "%s/#%s~%d#" % (
199 self.cachedir, cache_corename, os.getpid())
200 f = file(cache_tmp, 'w')
203 os.rename(cache_tmp, cache_item)
204 debug('Fetcher stored')
207 def yoweb(self, kind, tail, max_age):
209 url = 'http://%s.puzzlepirates.com/yoweb/%s%s' % (
210 self.ocean, kind, tail)
211 return self.fetch(url, max_age)
213 #---------- logging assistance for troubled screenscrapers ----------
220 def soupm(self, obj, m):
221 self.msg(m + '; in ' + `obj`)
222 def needs_msgs(self, child_souplog):
223 self.msgs += child_souplog.msgs
224 child_souplog.msgs = [ ]
227 str = ''.join(obj.findAll(text=True))
230 class SomethingSoupInfo(SoupLog):
231 def __init__(self, kind, tail, max_age):
232 SoupLog.__init__(self)
233 html = fetcher.yoweb(kind, tail, max_age)
234 self._soup = BeautifulSoup(html,
235 convertEntities=BeautifulSoup.HTML_ENTITIES
238 #---------- scraper for pirate pages ----------
240 class PirateInfo(SomethingSoupInfo):
241 # Public data members:
242 # pi.standings = { 'Treasure Haul': 'Able' ... }
244 # pi.crew = (id, name)
245 # pi.flag = (id, name)
246 # pi.msgs = [ 'message describing problem with scrape' ]
248 def __init__(self, pirate, max_age=300):
249 SomethingSoupInfo.__init__(self,
250 'pirate.wm?target=', pirate, max_age)
252 self._find_standings()
253 self.crew = self._find_crewflag('crew',
254 '^/yoweb/crew/info\\.wm')
255 self.flag = self._find_crewflag('flag',
256 '^/yoweb/flag/info\\.wm')
258 def _find_standings(self):
259 imgs = self._soup.findAll('img',
260 src=regexp.compile('/yoweb/images/stat.*'))
262 u'\\s*\\S*/([-A-Za-z]+)\\s*$|\\s*\\S*/\\S*\\s*\\(ocean\\-wide(?:\\s|\\xa0)+([-A-Za-z]+)\\)\\s*$'
266 for skill in puzzles:
267 standings[skill] = [ ]
272 try: puzzle = img['alt']
273 except KeyError: continue
275 if not puzzle in puzzles:
276 skl.soupm(img, 'unknown puzzle: "%s"' % puzzle)
278 key = img.findParent('td')
280 skl.soupm(img, 'puzzle at root! "%s"' % puzzle)
282 valelem = key.findNextSibling('td')
284 skl.soupm(key, 'puzzle missing sibling "%s"'
287 valstr = soup_text(valelem)
288 match = re.match(valstr)
290 skl.soupm(key, ('puzzle "%s" unparseable'+
291 ' standing "%s"') % (puzzle, valstr))
293 standing = match.group(match.lastindex)
294 standings[puzzle].append(standing)
298 for puzzle in puzzles:
299 sl = standings[puzzle]
301 skl.msg('puzzle "%s" multiple standings %s' %
305 skl.msg('puzzle "%s" no standing found' % puzzle)
308 for i in range(0, standing_limit):
309 if standing == standingvals[i]:
310 self.standings[puzzle] = i
311 if not puzzle in self.standings:
312 skl.msg('puzzle "%s" unknown standing "%s"' %
315 all_standings_ok = True
316 for puzzle in puzzles:
317 if not puzzle in self.standings:
320 def _find_crewflag(self, cf, yoweb_re):
321 things = self._soup.findAll('a', href=regexp.compile(yoweb_re))
323 self.msg('zero or several %s id references found' % cf)
326 id_re = '\\b%sid\\=(\\w+)$' % cf
327 id_haystack = thing['href']
328 match = regexp.compile(id_re).search(id_haystack)
330 self.soupm(thing, ('incomprehensible %s id ref'+
331 ' (%s in %s)') % (cf, id_re, id_haystack))
333 name = soup_text(thing)
334 return (match.group(1), name)
337 return `(self.crew, self.flag, self.standings, self.msgs)`
339 #---------- scraper for crew pages ----------
341 class CrewInfo(SomethingSoupInfo):
342 # Public data members:
343 # ci.crew = [ ('Captain', ['Pirate', ...]),
344 # ('Senior Officer', [...]),
346 # pi.msgs = [ 'message describing problem with scrape' ]
348 def __init__(self, crewid, max_age=300):
349 SomethingSoupInfo.__init__(self,
350 'crew/info.wm?crewid=', crewid, max_age)
353 def _find_crew(self):
355 capts = self._soup.findAll('img',
356 src='/yoweb/images/crew-captain.png')
358 self.msg('crew members: no. of captain images != 1')
361 while not tbl.find('a', href=pirate_ref_re):
362 tbl = tbl.findParent('table')
364 self.msg('crew members: cannot find table')
366 current_rank_crew = None
367 crew_rank_re = regexp.compile('/yoweb/images/crew')
368 for row in tbl.contents:
369 # findAll(recurse=False)
370 if isinstance(row,basestring):
373 is_rank = row.find('img', attrs={'src': crew_rank_re})
375 rank = soup_text(row)
376 current_rank_crew = []
377 self.crew.append((rank, current_rank_crew))
379 for cell in row.findAll('a', href=pirate_ref_re):
380 if current_rank_crew is None:
381 self.soupm(cell, 'crew members: crew'
384 current_rank_crew.append(soup_text(cell))
387 return `(self.crew, self.msgs)`
389 class FlagInfo(SomethingSoupInfo):
390 def __init__(self, flagid, max_age=600):
391 SomethingSoupInfo.__init__(self,
392 'flag/info.wm?flagid=', flagid, max_age)
395 def _find_flag(self):
396 font2 = self._soup.find('font',{'size':'+2'})
397 self.flag = font2.find('b').contents[0]
398 magnate = self._soup.find('img',{'src':
399 '/yoweb/images/repute-MAGNATE.png'})
400 warinfo = (magnate.findParent('table').findParent('tr').
401 findNextSibling('tr').findNext('td',{'align':'left'}))
402 for waritem in warinfo.contents:
403 print 'ITEM ',`waritem`
405 #---------- scraper for ocean info incl. embargoes etc. ----------
408 def __init__(self, ocean, islename):
413 def yppedia_dataf(self):
414 def q(x): return urllib.quote(x.replace(' ','_'))
415 url_rhs = q(self.name) + '_(' + q(self.ocean) + ')'
416 if opts.localhtml is None:
417 url = 'http://yppedia.puzzlepirates.com/' + url_rhs
418 debug('IslandInfo retrieving YPP '+url);
419 return urllib.urlopen(url)
421 return file(opts.localhtml + '/' + url_rhs, 'r')
423 soup = BeautifulSoup(self.yppedia_dataf())
424 content = soup.find('div', attrs = {'id': 'content'})
425 yoweb_re = regexp.compile('^http://\w+\.puzzlepirates\.com/'+
426 'yoweb/island/info\.wm\?islandid=\d+$')
427 a = soup.find('a', attrs = { 'href': yoweb_re })
428 if a is None: return None
430 def ruling_flag_id(self):
431 yo = self.yoweb_url()
432 if yo is None: return None
433 dataf = fetcher.fetch(yo, 600)
434 soup = BeautifulSoup(dataf)
435 ruler_re = regexp.compile('http://\w+\.puzzlepirates\.com/'+
436 'yoweb/flag/info\.wm\?flagid=(\d+)$')
437 ruler = soup.find('a', attrs = { 'href': ruler_re })
438 if not ruler: return None
439 m = ruler_re.find(ruler['href'])
443 # Public data attributes (valid after collect()):
444 # oi.islands[islename] = IslandInfo(...)
445 # oi.arches[archname][islename] = IslandInfo(...)
447 self.isleclass = IslandInfo
448 self.ocean = fetcher.ocean.lower().capitalize()
450 cmdl = ['./yppedia-ocean-scraper']
451 if opts.localhtml is not None:
452 cmdl += ['--local-html-dir',opts.localhtml]
454 debug('OceanInfo collect running ' + `cmdl`)
455 oscraper = subprocess.Popen(
457 stdout = subprocess.PIPE,
458 cwd = yppsc_dir()+'/yarrg',
459 shell=False, stderr=None,
461 h = oscraper.stdout.readline()
462 debug('OceanInfo collect h '+`h`)
463 assert(regexp.match('^ocean ', h))
464 arch_re = regexp.compile('^ (\S.*)')
465 island_re = regexp.compile('^ (\S.*)')
471 for l in oscraper.stdout:
472 debug('OceanInfo collect l '+`l`)
474 m = island_re.match(l)
476 assert(archname is not None)
477 islename = m.group(1)
478 isle = self.isleclass(self.ocean, islename)
480 self.islands[islename] = isle
481 self.arches[archname][islename] = isle
485 archname = m.group(1)
486 assert(archname not in self.arches)
487 self.arches[archname] = { }
491 assert(oscraper.returncode == 0)
493 #---------- pretty-printer for tables of pirate puzzle standings ----------
495 class StandingsTable:
496 def __init__(self, f, use_puzzles=None, col_width=6, gap_every=5):
497 if use_puzzles is None:
499 use_puzzles=duty_puzzles
502 self._puzzles = use_puzzles
504 self._cw = col_width-1
505 self._gap_every = gap_every
509 def _nl(self): self._o('\n')
511 def _pline(self, lhs, puzstrs, extra):
512 if (self._linecount > 0
513 and self._gap_every is not None
514 and not (self._linecount % self._gap_every)):
516 self._o('%-*s' % (max(max_pirate_namelen+1, 15), lhs))
518 self._o(' %-*.*s' % (self._cw,self._cw, v))
524 def _puzstr(self, pi, puzzle):
525 if not isinstance(puzzle,list): puzzle = [puzzle]
526 try: standing = max([pi.standings[p] for p in puzzle])
527 except KeyError: return '?'
528 if not standing: return ''
531 c1 = standingvals[standing][0]
532 if standing < 3: c1 = c1.lower() # 3 = Master
536 s += '*' * (standing / 2)
537 s += '+' * (standing % 2)
540 def headings(self, lhs='', rhs=None):
541 def puzn_redact(name):
542 if isinstance(name,list):
544 ["%.*s" % (self._cw/2, puzn_redact(n))
547 if spc < 0: return name
548 return name[0:min(4,spc)] + name[spc+1:]
550 self._pline(lhs, map(puzn_redact, self._puzzles), rhs)
552 def literalline(self, line):
556 def pirate_dummy(self, name, standingstring, extra=None):
557 standings = standingstring * len(self._puzzles)
558 self._pline(' '+name, standings, extra)
559 def pirate(self, pi, extra=None):
560 puzstrs = [self._puzstr(pi,puz) for puz in self._puzzles]
561 self._pline(' '+pi.name, puzstrs, extra)
564 #---------- chat log parser ----------
567 # This is essentially a transparent, dumb, data class.
577 # Also used for jobbing applicants:
578 # happens when expires (to "-")
579 # - disembark, leaves crew no
580 # aboard evidence of them being aboard no
581 # applied "has applied for the job" 120s, configurable
582 # ashore "has taken a job" 30min, configurable
583 # declined "declined the job offer" 30s, configurable
584 # invited "has been invited to job" 120s, configurable
586 # pa.jobber None, 'ashore', 'applied', 'invited', 'declined'
587 # pa.expires expiry time time
589 def __init__(pa, pn, v, time, event):
593 pa.last_event = event
594 pa.last_chat_time = None
595 pa.last_chat_chan = None
604 age = now - pa.pi_fetched
605 guide = random.randint(120,240)
608 debug('PirateAboard refresh %d > %d %s' % (
609 age, guide, pa.name))
613 wait = fetcher.need_wait(now, imaginary)
615 debug('PirateAboard fetcher not ready %d' % wait)
617 pa.pi = PirateInfo(pa.name, 600)
621 class ChatLogTracker:
622 # This is quite complex so we make it opaque. Use the
623 # official invokers, accessors etc.
625 def __init__(self, myself_pi, logfn):
626 self._pl = {} # self._pl['Pirate'] =
627 self._vl = {} # self._vl['Vessel']['Pirate'] = PirateAboard
628 # self._vl['Vessel']['#lastinfo']
629 # self._vl['Vessel']['#name']
630 # self._v = self._vl[self._vessel]
632 self._myself = myself_pi
634 self._f = file(logfn)
635 flen = os.fstat(self._f.fileno()).st_size
637 if flen > max_backlog:
638 startpos = flen - max_backlog
639 self._f.seek(startpos)
641 self._progress = [0, flen - self._f.tell()]
642 self._disembark_myself()
643 self._need_redisplay = False
644 self._lastvessel = None
646 def _disembark_myself(self):
649 self.force_redisplay()
651 def force_redisplay(self):
652 self._need_redisplay = True
654 def _vessel_updated(self, v, timestamp):
656 v['#lastinfo'] = timestamp
657 self.force_redisplay()
659 def _onboard_event(self,v,timestamp,pirate,event,jobber=None):
660 pa = self._pl.get(pirate, None)
661 if pa is not None and pa.v is v:
662 pa.last_time = timestamp
663 pa.last_event = event
665 if pa is not None and pa.v is not None:
667 pa = PirateAboard(pirate, v, timestamp, event)
668 self._pl[pirate] = pa
669 if v is not None: v[pirate] = pa
672 if jobber is None: timeout = None
673 else: timeout = getattr(opts, 'timeout_'+jobber)
674 if timeout is None: pa.expires = None
675 else: pa.expires = timestamp + timeout
676 self._vessel_updated(v, timestamp)
679 def _expire_jobbers(self, now):
680 for pa in self._pl.values():
681 if pa.expires is None: continue
682 if pa.expires >= now: continue
684 del self._pl[pa.name]
685 if v is not None: del v[pa.name]
686 self.force_redisplay()
688 def _trash_vessel(self, v):
690 if pn.startswith('#'): continue
694 if v is self._v: self._disembark_myself()
695 self.force_redisplay()
697 def _vessel_stale(self, v, timestamp):
698 return timestamp - v['#lastinfo'] > opts.ship_reboard_clearout
700 def _vessel_check_expire(self, v, timestamp):
701 if not self._vessel_stale(v, timestamp):
703 self._debug_line_disposition(timestamp,'',
704 'stale-reset ' + v['#name'])
705 self._trash_vessel(v)
708 def expire_garbage(self, timestamp):
709 for v in self._vl.values():
710 self._vessel_check_expire(v, timestamp)
712 def _vessel_lookup(self, vn, timestamp, dml=[], create=False):
713 v = self._vl.get(vn, None)
715 v = self._vessel_check_expire(v, timestamp)
722 self._vl[vn] = v = { '#name': vn }
723 self._vessel_updated(v, timestamp)
726 def _find_matching_vessel(self, pattern, timestamp, cmdr,
727 dml=[], create=False):
728 # use when a commander pirate `cmdr' specified a vessel
729 # by name `pattern' (either may be None)
730 # if create is true, will create the vessel
731 # record if an exact name is specified
733 if (pattern is not None and
735 and len(pattern.split(' ')) == 2):
738 return self._vessel_lookup(
739 vn, timestamp, dml=dml, create=create)
742 pattern_check = lambda vn: True
744 re = '(?:.* )?%s$' % pattern.lower().replace('*','.+')
745 pattern_check = regexp.compile(re, regexp.I).match
749 cmdr_pa = self._pl.get(cmdr, None)
750 if cmdr_pa: tries.append((cmdr_pa.v, 'cmdr'))
752 tries.append((self._v, 'here'))
755 for (v, dm) in tries:
756 if v is None: dml.append(dm+'?'); continue
759 if not pattern_check(vn):
767 if pattern is not None and '*' in pattern:
770 for (vn,v) in self._vl.iteritems()
771 if not self._vessel_stale(v, timestamp)
774 #debug('CLT-RE /%s/ wanted (%s) searched (%s)' % (
776 # '/'.join(tried_vns),
777 # '/'.join([vn for (vn,v) in search])))
787 def _debug_line_disposition(self,timestamp,l,m):
788 debug('CLT %13s %-40s %s' % (timestamp,m,l))
790 def _rm_crew_l(self,re,l):
791 m = regexp.match(re,l)
792 if m and m.group(2) == self._myself.crew[1]:
797 def local_command(self, metacmd):
798 # returns None if all went well, or problem message
799 return self._command(self._myself.name, metacmd,
800 "local", time.time(),
801 (lambda m: debug('CMD %s' % metacmd)))
803 def _command(self, cmdr, metacmd, chan, timestamp, d):
804 # returns None if all went well, or problem message
805 metacmd = regexp.sub('\\s+', ' ', metacmd).strip()
807 '/([adj]) (?:([A-Za-z* ]+)\\s*:)?([A-Za-z ]+)$',
809 if not m2: return "unknown syntax or command"
811 (cmd, pattern, targets) = m2.groups()
812 dml = ['cmd', chan, cmd]
814 if cmd == 'a': each = self._onboard_event
815 elif cmd == 'd': each = disembark
816 else: each = lambda *l: self._onboard_event(*l,
817 **{'jobber':'applied'})
819 if cmdr == self._myself.name:
821 how = 'cmd: %s' % cmd
824 how = 'cmd: %s %s' % (cmd,cmdr)
827 if pattern is not None:
828 return "/j command does not take a vessel"
831 v = self._find_matching_vessel(
832 pattern, timestamp, cmdr,
835 if cmd == 'j' or v is not None:
836 targets = targets.strip().split(' ')
837 dml.append(`len(targets)`)
838 for target in targets:
839 each(v, timestamp, target.title(), how)
840 self._vessel_updated(v, timestamp)
847 def chatline(self,l):
848 rm = lambda re: regexp.match(re,l)
849 d = lambda m: self._debug_line_disposition(timestamp,l,m)
850 rm_crew = lambda re: self._rm_crew_l(re,l)
853 m = rm('=+ (\\d+)/(\\d+)/(\\d+) =+$')
855 self._date = [int(x) for x in m.groups()]
856 self._previous_timestamp = None
857 return d('date '+`self._date`)
859 if self._date is None:
860 return d('date unset')
862 m = rm('\\[(\d\d):(\d\d):(\d\d)\\] ')
864 return d('no timestamp')
867 time_tuple = (self._date +
868 [int(x) for x in m.groups()] +
870 timestamp = time.mktime(time_tuple)
871 if timestamp >= self._previous_timestamp: break
873 self._debug_line_disposition(timestamp,'',
874 'new date '+`self._date`)
876 self._previous_timestamp = timestamp
878 l = l[l.find(' ')+1:]
880 def ob_x(pirate,event):
881 return self._onboard_event(
882 self._v, timestamp, pirate, event)
883 def ob1(did): ob_x(m.group(1), did); return d(did)
884 def oba(did): return ob1('%s %s' % (did, m.group(2)))
886 def jb(pirate,jobber):
887 return self._onboard_event(
888 None, timestamp, pirate,
889 ("jobber %s" % jobber),
893 def disembark(v, timestamp, pirate, event):
895 v, timestamp, pirate, 'leaving '+event)
899 def disembark_me(why):
900 self._disembark_myself()
901 return d('disembark-me '+why)
903 m = rm('Going aboard the (\\S.*\\S)\\.\\.\\.$')
906 pn = self._myself.name
908 v = self._vessel_lookup(vn, timestamp, dm, create=True)
909 self._lastvessel = self._vessel = vn
911 ob_x(pn, 'we boarded')
912 self.expire_garbage(timestamp)
913 return d(' '.join(dm))
916 return d('no vessel')
918 m = rm('(\\w+) has come aboard\\.$')
919 if m: return ob1('boarded');
921 m = rm('You have ordered (\\w+) to do some (\\S.*\\S)\\.$')
923 (who,what) = m.groups()
924 pa = ob_x(who,'ord '+what)
925 if what == 'Gunning':
927 return d('duty order')
929 m = rm('(\\w+) abandoned a (\\S.*\\S) station\\.$')
930 if m: oba('stopped'); return d("end")
932 def chat_core(speaker, chan):
933 try: pa = self._pl[speaker]
934 except KeyError: return 'mystery'
935 if pa.v is not None and pa.v is not self._v:
937 pa.last_chat_time = timestamp
938 pa.last_chat_chan = chan
939 self.force_redisplay()
944 dm = chat_core(speaker, chan)
945 return d('chat %s %s' % (chan, dm))
947 def chat_metacmd(chan):
948 (cmdr, metacmd) = m.groups()
949 whynot = self._command(
950 cmdr, metacmd, chan, timestamp, d)
951 if whynot is not None:
954 chat_core(cmdr, 'cmd '+chan)
956 m = rm('(\\w+) (?:issued an order|ordered everyone) "')
957 if m: return ob1('general order');
959 m = rm('(\\w+) says, "')
960 if m: return chat('public')
962 m = rm('(\\w+) tells ye, "')
963 if m: return chat('private')
965 m = rm('Ye told (\\w+), "(.*)"$')
966 if m: return chat_metacmd('private')
968 m = rm('(\\w+) flag officer chats, "')
969 if m: return chat('flag officer')
971 m = rm('(\\w+) officer chats, "(.*)"$')
972 if m: return chat_metacmd('officer')
974 m = rm('Ye accepted the offer to job with ')
975 if m: return disembark_me('jobbing')
977 m = rm('Ye hop on the ferry and are whisked away ')
978 if m: return disembark_me('ferry')
980 m = rm('Whisking away to yer home on the magical winds')
981 if m: return disembark_me('home')
983 m = rm('Game over\\. Winners: ([A-Za-z, ]+)\\.$')
985 pl = m.group(1).split(', ')
986 if not self._myself.name in pl:
987 return d('lost melee')
989 if ' ' in pn: continue
991 return d('won melee')
993 m = rm('(\\w+) is eliminated\\!')
994 if m: return ob1('eliminated in fray');
996 m = rm('(\\w+) has driven \w+ from the ship\\!')
997 if m: return ob1('boarder repelled');
999 m = rm('\w+ has bested (\\w+), and turns'+
1000 ' to the rest of the ship\\.')
1001 if m: return ob1('boarder unrepelled');
1003 pirate = rm_crew("(\\w+) has taken a job with '(.*)'\\.")
1004 if pirate: return jb(pirate, 'ashore')
1006 pirate = rm_crew("(\\w+) has left '(.*)'\\.")
1008 disembark(self._v, timestamp, pirate, 'left crew')
1009 return d('left crew')
1011 m = rm('(\w+) has applied for the posted job\.')
1012 if m: return jb(m.group(1), 'applied')
1014 pirate= rm_crew("(\\w+) has been invited to job for '(.*)'\\.")
1015 if pirate: return jb(pirate, 'invited')
1017 pirate = rm_crew("(\\w+) declined the job offer for '(.*)'\\.")
1018 if pirate: return jb(pirate, 'declined')
1020 m = rm('(\\w+) has left the vessel\.')
1023 disembark(self._v, timestamp, pirate, 'disembarked')
1024 return d('disembarked')
1026 return d('not-matched')
1028 def _str_pa(self, pn, pa):
1029 assert self._pl[pn] == pa
1030 s = ' '*20 + "%s %-*s %13s %-30s %13s %-20s %13s" % (
1031 (' ','G')[pa.gunner],
1032 max_pirate_namelen, pn,
1033 pa.last_time, pa.last_event,
1034 pa.last_chat_time, pa.last_chat_chan,
1036 if pa.expires is not None:
1037 s += " %-5d" % (pa.expires - pa.last_time)
1041 def _str_vessel(self, vn, v):
1042 s = ' vessel %s\n' % vn
1043 s += ' '*20 + "%-*s %13s\n" % (
1044 max_pirate_namelen, '#lastinfo',
1046 assert v['#name'] == vn
1047 for pn in sorted(v.keys()):
1048 if pn.startswith('#'): continue
1051 s += self._str_pa(pn,pa)
1055 s = '''<ChatLogTracker
1058 ''' % (self._myself.name, self._vessel)
1059 assert ((self._v is None and self._vessel is None) or
1060 (self._v is self._vl[self._vessel]))
1061 if self._vessel is not None:
1062 s += self._str_vessel(self._vessel, self._v)
1063 for vn in sorted(self._vl.keys()):
1064 if vn == self._vessel: continue
1065 s += self._str_vessel(vn, self._vl[vn])
1069 if pa.v is not None:
1070 assert pa.v[p] is pa
1071 assert pa.v in self._vl.values()
1073 s += self._str_pa(pa.name, pa)
1077 def catchup(self, progress=None):
1079 more = self._f.readline()
1082 self._progress[0] += len(more)
1083 if progress: progress.progress(*self._progress)
1086 if self._lbuf.endswith('\n'):
1087 self.chatline(self._lbuf.rstrip())
1090 debug(self.__str__())
1091 self._expire_jobbers(time.time())
1093 if progress: progress.caughtup()
1096 rv = self._need_redisplay
1097 self._need_redisplay = False
1100 # returns our pirate name
1101 return self._myself.name
1102 def vesselname(self):
1103 # returns the vessel name we're aboard or None
1105 def lastvesselname(self):
1106 # returns the last vessel name we were aboard or None
1107 return self._lastvessel
1108 def aboard(self, vesselname=True):
1109 # returns a list of PirateAboard the vessel
1110 # sorted by pirate name
1111 # you can pass this None and you'll get []
1112 # or True for the current vessel (which is the default)
1113 # the returned value is a fresh list of persistent
1114 # PirateAboard objects
1115 if vesselname is True: v = self._v
1116 else: v = self._vl.get(vesselname.title())
1117 if v is None: return []
1119 for pn in sorted(v.keys())
1120 if not pn.startswith('#') ]
1122 # returns a the jobbers' PirateAboards,
1123 # sorted by jobber class and reverse of expiry time
1125 for pa in self._pl.values()
1126 if pa.jobber is not None
1129 return (pa.jobber, -pa.expires)
1130 l.sort(key = compar_key)
1133 #---------- implementations of actual operation modes ----------
1135 def do_pirate(pirates, bu):
1137 for pirate in pirates:
1138 info = PirateInfo(pirate)
1139 print '%s: %s,' % (`pirate`, info)
1142 def prep_crew_of(args, bu, max_age=300):
1143 if len(args) != 1: bu('crew-of takes one pirate name')
1144 pi = PirateInfo(args[0], max_age)
1145 if pi.crew is None: return None
1146 return CrewInfo(pi.crew[0], max_age)
1148 def do_crew_of(args, bu):
1149 ci = prep_crew_of(args, bu)
1152 def do_flag_of(args, bu):
1153 if len(args) != 1: bu('flag-of takes one pirate name')
1155 pi = PirateInfo(args[0], max_age)
1156 if pi.flag is None: fi = None
1157 else: fi = FlagInfo(pi.flag[0], max_age)
1160 def do_standings_crew_of(args, bu):
1161 ci = prep_crew_of(args, bu, 60)
1162 tab = StandingsTable(sys.stdout)
1164 for (rank, members) in ci.crew:
1165 if not members: continue
1167 tab.literalline('%s:' % rank)
1169 pi = PirateInfo(p, random.randint(900,1800))
1172 def do_ocean(args, bu):
1173 if (len(args)): bu('ocean takes no further arguments')
1174 fetcher.default_ocean()
1177 for islename in sorted(oi.islands.keys()):
1178 isle = oi.islands[islename]
1179 yoweb_url = isle.yoweb_url()
1180 print " %s -- %s" % (islename, yoweb_url)
1182 #----- modes which use the chat log parser are quite complex -----
1184 class ProgressPrintPercentage:
1185 def __init__(self, f=sys.stdout):
1187 def progress_string(self,done,total):
1188 return "scan chat logs %3d%%\r" % ((done*100) / total)
1189 def progress(self,*a):
1190 self._f.write(self.progress_string(*a))
1192 def show_init(self, pirate, ocean):
1193 print >>self._f, 'Starting up, %s on the %s ocean' % (
1196 self._f.write(' \r')
1199 def prep_chat_log(args, bu,
1200 progress=ProgressPrintPercentage(),
1201 max_myself_age=3600):
1202 if len(args) != 1: bu('this action takes only chat log filename')
1204 logfn_re = '(?:.*/)?([A-Z][a-z]+)_([a-z]+)_'
1205 match = regexp.match(logfn_re, logfn)
1206 if not match: bu('chat log filename is not in expected format')
1207 (pirate, ocean) = match.groups()
1208 fetcher.default_ocean(ocean)
1210 progress.show_init(pirate, fetcher.ocean)
1211 myself = PirateInfo(pirate,max_myself_age)
1212 track = ChatLogTracker(myself, logfn)
1215 track.catchup(progress)
1218 track.force_redisplay()
1220 return (myself, track)
1222 def do_track_chat_log(args, bu):
1223 (myself, track) = prep_chat_log(args, bu)
1228 sleep(0.5 + 0.5 * random.random())
1230 #----- ship management aid -----
1232 class Display_dumb(ProgressPrintPercentage):
1234 ProgressPrintPercentage.__init__(self)
1237 def realstart(self):
1240 class Display_overwrite(ProgressPrintPercentage):
1242 ProgressPrintPercentage.__init__(self)
1244 null = file('/dev/null','w')
1245 curses.setupterm(fd=null.fileno())
1247 self._clear = curses.tigetstr('clear')
1249 self._debug('missing clear!')
1250 self.show = Display_dumb.show
1253 self._t = {'el':'', 'ed':''}
1254 if not self._init_sophisticated():
1255 for k in self._t.keys(): self._t[k] = ''
1256 self._t['ho'] = self._clear
1258 def _debug(self,m): debug('display overwrite: '+m)
1260 def _init_sophisticated(self):
1261 for k in self._t.keys():
1262 s = curses.tigetstr(k)
1264 self._t['ho'] = curses.tigetstr('ho')
1265 if not self._t['ho']:
1266 cup = curses.tigetstr('cup')
1267 self._t['ho'] = curses.tparm(cup,0,0)
1268 missing = [k for k in self._t.keys() if not self._t[k]]
1270 self.debug('missing '+(' '.join(missing)))
1275 w = sys.stdout.write
1276 def wti(k): w(self._t[k])
1280 for l in s.rstrip().split('\n'):
1289 def realstart(self):
1290 sys.stdout.write(self._clear)
1294 def do_ship_aid(args, bu):
1295 if opts.ship_duty is None: opts.ship_duty = True
1297 displayer = globals()['Display_'+opts.display]()
1299 (myself, track) = prep_chat_log(args, bu, progress=displayer)
1301 displayer.realstart()
1303 if os.isatty(0): kr_create = KeystrokeReader
1304 else: kr_create = DummyKeystrokeReader
1307 kreader = kr_create(0, 10)
1308 ship_aid_core(myself, track, displayer, kreader)
1313 class KeyBasedSorter:
1314 def compar_key_pa(self, pa):
1315 pi = pa.pirate_info()
1316 if pi is None: return None
1317 return self.compar_key(pi)
1318 def lsort_pa(self, l):
1319 l.sort(key = self.compar_key_pa)
1321 class NameSorter(KeyBasedSorter):
1322 def compar_key(self, pi): return pi.name
1323 def desc(self): return 'name'
1325 class SkillSorter(NameSorter):
1326 def __init__(self, relevant):
1327 self._want = frozenset(relevant.split('/'))
1329 for p in core_duty_puzzles:
1330 if isinstance(p,basestring): self._avoid.add(p)
1331 else: self._avoid |= set(p)
1332 self._avoid -= self._want
1333 self._desc = '%s' % relevant
1335 def desc(self): return self._desc
1337 def compar_key(self, pi):
1339 pi.standings.get(puz,-1)
1340 for puz in self._want
1343 -pi.standings.get(puz,standing_limit)
1344 for puz in self._avoid
1347 def negate(x): return -x
1348 debug('compar_key %s bw=%s ba=%s' % (pi.name, `best_want`,
1350 return (-best_want, map(negate, best_avoid), pi.name)
1352 def ship_aid_core(myself, track, displayer, kreader):
1355 vn = track.vesselname()
1356 if vn: return (vn, " on board the %s" % vn)
1357 vn = track.lastvesselname()
1358 if vn: return (vn, " ashore from the %s" % vn)
1359 return (None, " not on a vessel")
1362 if t is None: return ' ' * 22
1363 return " %-4s %-16s" % (format_time_interval(now - t),e)
1365 displayer.show(track.myname() + find_vessel()[1] + '...')
1378 (vn, vs) = find_vessel()
1381 if cliexec is not None:
1383 elif clierr is not None:
1384 s += 'Error: '+clierr
1385 elif clicmd is not None:
1388 s = track.myname() + vs
1389 s += " at %s" % time.strftime("%Y-%m-%d %H:%M:%S")
1394 tbl = StandingsTable(tbl_s)
1396 aboard = track.aboard(vn)
1397 sort.lsort_pa(aboard)
1399 jobbers = track.jobbers()
1401 if track.vesselname(): howmany = 'aboard: %2d' % len(aboard)
1404 tbl.headings(howmany, ' sorted by '+sort.desc())
1408 for pa in aboard + jobbers:
1409 if pa.jobber != last_jobber:
1410 last_jobber = pa.jobber
1412 tbl.literalline('jobbers '+last_jobber)
1414 pi = pa.pirate_info()
1417 if pa.gunner: xs += 'G '
1419 xs += timeevent(pa.last_time, pa.last_event)
1420 xs += timeevent(pa.last_chat_time, pa.last_chat_chan)
1423 tbl.pirate_dummy(pa.name, rotate_nya[0], xs)
1427 s += tbl_s.getvalue()
1431 if cliexec is not None:
1432 clierr = track.local_command("/"+cliexec.strip())
1438 rotate_nya = rotate_nya[1:3] + rotate_nya[0]
1441 if clierr is not None:
1445 if clicmd is not None:
1446 if k == '\r' or k == '\n':
1449 elif k == '\e' and clicmd != "":
1453 elif k == '\b' or k == '\177':
1454 clicmd = clicmd[ 0 : len(clicmd)-1 ]
1460 elif k == 'g': sort = SkillSorter('Gunning')
1461 elif k == 'c': sort = SkillSorter('Carpentry')
1462 elif k == 's': sort = SkillSorter('Sailing/Rigging')
1463 elif k == 'b': sort = SkillSorter('Bilging')
1464 elif k == 'n': sort = SkillSorter('Navigating')
1465 elif k == 'd': sort = SkillSorter('Battle Navigation')
1466 elif k == 't': sort = SkillSorter('Treasure Haul')
1467 elif k == 'a': sort = NameSorter()
1468 elif k == '/': clicmdbase = ""; clicmd = clicmdbase
1469 elif k == '+': clicmdbase = "a "; clicmd = clicmdbase
1470 else: pass # unknown key command
1472 #---------- individual keystroke input ----------
1474 class DummyKeystrokeReader:
1475 def __init__(self,fd,timeout_dummy): pass
1476 def stop(self): pass
1477 def getch(self): sleep(1); return None
1478 def info(self): return ' [noninteractive]'
1480 class KeystrokeReader(DummyKeystrokeReader):
1481 def __init__(self, fd, timeout_decisec=0):
1483 self._saved = termios.tcgetattr(fd)
1484 a = termios.tcgetattr(fd)
1485 a[3] &= ~(termios.ECHO | termios.ECHONL |
1486 termios.ICANON | termios.IEXTEN)
1487 a[6][termios.VMIN] = 0
1488 a[6][termios.VTIME] = timeout_decisec
1489 termios.tcsetattr(fd, termios.TCSANOW, a)
1491 termios.tcsetattr(self._fd, termios.TCSANOW, self._saved)
1494 byte = os.read(self._fd, 1)
1495 if not len(byte): return None
1500 #---------- main program ----------
1503 global opts, fetcher
1506 '''usage: .../yoweb-scrape [OPTION...] ACTION [ARGS...]
1508 yoweb-scrape [--ocean OCEAN ...] pirate PIRATE
1509 yoweb-scrape [--ocean OCEAN ...] crew-of PIRATE
1510 yoweb-scrape [--ocean OCEAN ...] standings-crew-of PIRATE
1511 yoweb-scrape [--ocean OCEAN ...] track-chat-log CHAT-LOG
1512 yoweb-scrape [options] ship-aid CHAT-LOG (must be .../PIRATE_OCEAN_chat-log*)
1514 display modes (for --display) apply to ship-aid:
1515 --display=dumb just print new information, scrolling the screen
1516 --display=overwrite use cursor motion, selective clear, etc. to redraw at top''')
1518 ao('-O','--ocean',dest='ocean', metavar='OCEAN', default=None,
1519 help='select ocean OCEAN')
1520 ao('--cache-dir', dest='cache_dir', metavar='DIR',
1521 default='~/.yoweb-scrape-cache',
1522 help='cache yoweb pages in DIR')
1523 ao('-D','--debug', action='count', dest='debug', default=0,
1524 help='enable debugging output')
1525 ao('--debug-fd', type='int', dest='debug_fd',
1526 help='write any debugging output to specified fd')
1527 ao('-q','--quiet', action='store_true', dest='quiet',
1528 help='suppress warning output')
1529 ao('--display', action='store', dest='display',
1530 type='choice', choices=['dumb','overwrite'],
1531 help='how to display ship aid')
1532 ao('--local-ypp-dir', action='store', dest='localhtml',
1533 help='get yppedia pages from local directory LOCALHTML'+
1534 ' instead of via HTTP')
1536 ao_jt = lambda wh, t: ao(
1537 '--timeout-sa-'+wh, action='store', dest='timeout_'+wh,
1538 default=t, help=('set timeout for expiring %s jobbers' % wh))
1539 ao_jt('applied', 120)
1540 ao_jt('invited', 120)
1541 ao_jt('declined', 30)
1542 ao_jt('ashore', 1800)
1544 ao('--ship-duty', action='store_true', dest='ship_duty',
1545 help='show ship duty station puzzles')
1546 ao('--all-puzzles', action='store_false', dest='ship_duty',
1547 help='show all puzzles, not just ship duty stations')
1549 ao('--min-cache-reuse', type='int', dest='min_max_age',
1550 metavar='SECONDS', default=60,
1551 help='always reuse cache yoweb data if no older than this')
1553 (opts,args) = pa.parse_args()
1557 print >>sys.stderr, copyright_info
1558 pa.error('need a mode argument')
1560 if opts.debug_fd is not None:
1561 opts.debug_file = os.fdopen(opts.debug_fd, 'w')
1563 opts.debug_file = sys.stdout
1566 mode_fn_name = 'do_' + mode.replace('_','#').replace('-','_')
1567 try: mode_fn = globals()[mode_fn_name]
1568 except KeyError: pa.error('unknown mode "%s"' % mode)
1571 opts.expire_age = max(3600, opts.min_max_age)
1573 opts.ship_reboard_clearout = 3600
1575 if opts.cache_dir.startswith('~/'):
1576 opts.cache_dir = os.getenv('HOME') + opts.cache_dir[1:]
1578 if opts.display is None:
1579 if ((opts.debug > 0 and opts.debug_fd is None)
1580 or not os.isatty(sys.stdout.fileno())):
1581 opts.display = 'dumb'
1583 opts.display = 'overwrite'
1585 fetcher = Fetcher(opts.ocean, opts.cache_dir)
1587 mode_fn(args[1:], pa.error)