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 # Public data members (after init):
394 # relations[n] = (otherflagname, otherflagid, [stringfromyoweb],
395 # thisdeclaring, otherdeclaringmin, otherdeclaringmax)
396 # # where {this,other}declaring{,min,max} are:
397 # # -1 {this,other} is declaring war
398 # # 0 {this,other} is not doing either
399 # # +1 {this,other} is allying
400 # relation_byname[otherflagname] = relations[some_n]
401 # relation_byid[otherflagname] = relations[some_n]
403 # islands[n] = (islandname, islandid)
405 def __init__(self, flagid, max_age=600):
406 SomethingSoupInfo.__init__(self,
407 'flag/info.wm?flagid=', flagid, max_age)
410 def _find_flag(self):
411 font2 = self._soup.find('font',{'size':'+2'})
412 self.name = font2.find('b').contents[0]
415 self.relation_byname = { }
416 self.relation_byid = { }
419 magnate = self._soup.find('img',{'src':
420 '/yoweb/images/repute-MAGNATE.png'})
421 warinfo = (magnate.findParent('table').findParent('tr').
422 findNextSibling('tr').findNext('td',{'align':'left'}))
425 print >>sys.stderr, 'WARNING: '+m
427 def wi_warn(head, waritem):
428 warn('unknown warmap item: %s: %s' %
429 (`head`, ``waritem``))
431 def wihelp_item(waritem, thing):
432 url = waritem.get('href', None)
434 return ('no url for '+thing,None,None)
435 m = regexp.search('\?'+thing+'id=(\d+)$', url)
436 if not m: return ('no '+thing+'id',None,None)
438 tname = waritem.string
440 return (thing+' name not just string',None,None)
441 return (None,tid,tname)
443 def wi_alwar(head, waritem, thisdecl, othermin, othermax):
444 (err,flagid,flagname) = wihelp_item(waritem,'flag')
446 rel = self.relation_byid.get(flagid, None)
447 if rel: return 'flag id twice!'
448 if flagname in self.relation_byname:
449 return 'flag name twice!'
450 rel = (flagname,flagid,head, thisdecl,othermin,othermax)
451 self.relations.append(rel)
452 self.relation_byid[flagid] = rel
453 self.relation_byname[flagid] = rel
455 def wi_isle(head, waritem):
456 (err,isleid,islename) = wihelp_item(waritem,'island')
458 self.islands.append((isleid,islename))
461 'Allied with': (wi_alwar,+1,+1,+1),
462 'Declaring war against': (wi_alwar,-1, 0,+1),
463 'At war with': (wi_alwar,-1,-1,-1),
464 'Trying to form an alliance with': (wi_alwar,+1,-1,0),
465 'Islands controlled by this flag': (wi_isle,),
468 how = (wi_warn, None)
470 for waritem in warinfo.findAll(['font','a']):
471 if waritem is None: break
472 if waritem.name == 'font':
473 colour = waritem.get('color',None)
474 if colour.lstrip('#') != '958A5F':
475 warn('strange colour %s in %s' %
476 (colour,``waritem``))
478 head = waritem.string
480 warn('no head string in '+``waritem``)
482 head = regexp.sub('\\s+', ' ', head).strip()
483 head = head.rstrip(':')
484 how = (head,) + warmap.get(head, (wi_warn,))
486 assert(waritem.name == 'a')
488 debug('WARHOW %s(%s, waritem, *%s)' %
489 (how[1], `how[0]`, `how[2:]`))
490 bad = how[1](how[0], waritem, *how[2:])
492 warn('bad waritem %s: %s: %s' % (`how[0]`,
496 return `(self.name, self.islands, self.relations)`
498 #---------- scraper for ocean info incl. embargoes etc. ----------
501 def __init__(self, ocean, islename):
506 def yppedia_dataf(self):
507 def q(x): return urllib.quote(x.replace(' ','_'))
508 url_rhs = q(self.name) + '_(' + q(self.ocean) + ')'
509 if opts.localhtml is None:
510 url = 'http://yppedia.puzzlepirates.com/' + url_rhs
511 debug('IslandInfo retrieving YPP '+url);
512 return urllib.urlopen(url)
514 return file(opts.localhtml + '/' + url_rhs, 'r')
516 soup = BeautifulSoup(self.yppedia_dataf())
517 content = soup.find('div', attrs = {'id': 'content'})
518 yoweb_re = regexp.compile('^http://\w+\.puzzlepirates\.com/'+
519 'yoweb/island/info\.wm\?islandid=\d+$')
520 a = soup.find('a', attrs = { 'href': yoweb_re })
521 if a is None: return None
523 def ruling_flag_id(self):
524 yo = self.yoweb_url()
525 if yo is None: return None
526 dataf = fetcher.fetch(yo, 600)
527 soup = BeautifulSoup(dataf)
528 ruler_re = regexp.compile('http://\w+\.puzzlepirates\.com/'+
529 'yoweb/flag/info\.wm\?flagid=(\d+)$')
530 ruler = soup.find('a', attrs = { 'href': ruler_re })
531 if not ruler: return None
532 m = ruler_re.find(ruler['href'])
536 # Public data attributes (valid after collect()):
537 # oi.islands[islename] = IslandInfo(...)
538 # oi.arches[archname][islename] = IslandInfo(...)
540 self.isleclass = IslandInfo
541 self.ocean = fetcher.ocean.lower().capitalize()
543 cmdl = ['./yppedia-ocean-scraper']
544 if opts.localhtml is not None:
545 cmdl += ['--local-html-dir',opts.localhtml]
547 debug('OceanInfo collect running ' + `cmdl`)
548 oscraper = subprocess.Popen(
550 stdout = subprocess.PIPE,
551 cwd = yppsc_dir()+'/yarrg',
552 shell=False, stderr=None,
554 h = oscraper.stdout.readline()
555 debug('OceanInfo collect h '+`h`)
556 assert(regexp.match('^ocean ', h))
557 arch_re = regexp.compile('^ (\S.*)')
558 island_re = regexp.compile('^ (\S.*)')
564 for l in oscraper.stdout:
565 debug('OceanInfo collect l '+`l`)
567 m = island_re.match(l)
569 assert(archname is not None)
570 islename = m.group(1)
571 isle = self.isleclass(self.ocean, islename)
573 self.islands[islename] = isle
574 self.arches[archname][islename] = isle
578 archname = m.group(1)
579 assert(archname not in self.arches)
580 self.arches[archname] = { }
584 assert(oscraper.returncode == 0)
586 #---------- pretty-printer for tables of pirate puzzle standings ----------
588 class StandingsTable:
589 def __init__(self, f, use_puzzles=None, col_width=6, gap_every=5):
590 if use_puzzles is None:
592 use_puzzles=duty_puzzles
595 self._puzzles = use_puzzles
597 self._cw = col_width-1
598 self._gap_every = gap_every
602 def _nl(self): self._o('\n')
604 def _pline(self, lhs, puzstrs, extra):
605 if (self._linecount > 0
606 and self._gap_every is not None
607 and not (self._linecount % self._gap_every)):
609 self._o('%-*s' % (max(max_pirate_namelen+1, 15), lhs))
611 self._o(' %-*.*s' % (self._cw,self._cw, v))
617 def _puzstr(self, pi, puzzle):
618 if not isinstance(puzzle,list): puzzle = [puzzle]
619 try: standing = max([pi.standings[p] for p in puzzle])
620 except KeyError: return '?'
621 if not standing: return ''
624 c1 = standingvals[standing][0]
625 if standing < 3: c1 = c1.lower() # 3 = Master
629 s += '*' * (standing / 2)
630 s += '+' * (standing % 2)
633 def headings(self, lhs='', rhs=None):
634 def puzn_redact(name):
635 if isinstance(name,list):
637 ["%.*s" % (self._cw/2, puzn_redact(n))
640 if spc < 0: return name
641 return name[0:min(4,spc)] + name[spc+1:]
643 self._pline(lhs, map(puzn_redact, self._puzzles), rhs)
645 def literalline(self, line):
649 def pirate_dummy(self, name, standingstring, extra=None):
650 standings = standingstring * len(self._puzzles)
651 self._pline(' '+name, standings, extra)
652 def pirate(self, pi, extra=None):
653 puzstrs = [self._puzstr(pi,puz) for puz in self._puzzles]
654 self._pline(' '+pi.name, puzstrs, extra)
657 #---------- chat log parser ----------
660 # This is essentially a transparent, dumb, data class.
670 # Also used for jobbing applicants:
671 # happens when expires (to "-")
672 # - disembark, leaves crew no
673 # aboard evidence of them being aboard no
674 # applied "has applied for the job" 120s, configurable
675 # ashore "has taken a job" 30min, configurable
676 # declined "declined the job offer" 30s, configurable
677 # invited "has been invited to job" 120s, configurable
679 # pa.jobber None, 'ashore', 'applied', 'invited', 'declined'
680 # pa.expires expiry time time
682 def __init__(pa, pn, v, time, event):
686 pa.last_event = event
687 pa.last_chat_time = None
688 pa.last_chat_chan = None
697 age = now - pa.pi_fetched
698 guide = random.randint(120,240)
701 debug('PirateAboard refresh %d > %d %s' % (
702 age, guide, pa.name))
706 wait = fetcher.need_wait(now, imaginary)
708 debug('PirateAboard fetcher not ready %d' % wait)
710 pa.pi = PirateInfo(pa.name, 600)
714 class ChatLogTracker:
715 # This is quite complex so we make it opaque. Use the
716 # official invokers, accessors etc.
718 def __init__(self, myself_pi, logfn):
719 self._pl = {} # self._pl['Pirate'] =
720 self._vl = {} # self._vl['Vessel']['Pirate'] = PirateAboard
721 # self._vl['Vessel']['#lastinfo']
722 # self._vl['Vessel']['#name']
723 # self._v = self._vl[self._vessel]
725 self._myself = myself_pi
727 self._f = file(logfn)
728 flen = os.fstat(self._f.fileno()).st_size
730 if flen > max_backlog:
731 startpos = flen - max_backlog
732 self._f.seek(startpos)
734 self._progress = [0, flen - self._f.tell()]
735 self._disembark_myself()
736 self._need_redisplay = False
737 self._lastvessel = None
739 def _disembark_myself(self):
742 self.force_redisplay()
744 def force_redisplay(self):
745 self._need_redisplay = True
747 def _vessel_updated(self, v, timestamp):
749 v['#lastinfo'] = timestamp
750 self.force_redisplay()
752 def _onboard_event(self,v,timestamp,pirate,event,jobber=None):
753 pa = self._pl.get(pirate, None)
754 if pa is not None and pa.v is v:
755 pa.last_time = timestamp
756 pa.last_event = event
758 if pa is not None and pa.v is not None:
760 pa = PirateAboard(pirate, v, timestamp, event)
761 self._pl[pirate] = pa
762 if v is not None: v[pirate] = pa
765 if jobber is None: timeout = None
766 else: timeout = getattr(opts, 'timeout_'+jobber)
767 if timeout is None: pa.expires = None
768 else: pa.expires = timestamp + timeout
769 self._vessel_updated(v, timestamp)
772 def _expire_jobbers(self, now):
773 for pa in self._pl.values():
774 if pa.expires is None: continue
775 if pa.expires >= now: continue
777 del self._pl[pa.name]
778 if v is not None: del v[pa.name]
779 self.force_redisplay()
781 def _trash_vessel(self, v):
783 if pn.startswith('#'): continue
787 if v is self._v: self._disembark_myself()
788 self.force_redisplay()
790 def _vessel_stale(self, v, timestamp):
791 return timestamp - v['#lastinfo'] > opts.ship_reboard_clearout
793 def _vessel_check_expire(self, v, timestamp):
794 if not self._vessel_stale(v, timestamp):
796 self._debug_line_disposition(timestamp,'',
797 'stale-reset ' + v['#name'])
798 self._trash_vessel(v)
801 def expire_garbage(self, timestamp):
802 for v in self._vl.values():
803 self._vessel_check_expire(v, timestamp)
805 def _vessel_lookup(self, vn, timestamp, dml=[], create=False):
806 v = self._vl.get(vn, None)
808 v = self._vessel_check_expire(v, timestamp)
815 self._vl[vn] = v = { '#name': vn }
816 self._vessel_updated(v, timestamp)
819 def _find_matching_vessel(self, pattern, timestamp, cmdr,
820 dml=[], create=False):
821 # use when a commander pirate `cmdr' specified a vessel
822 # by name `pattern' (either may be None)
823 # if create is true, will create the vessel
824 # record if an exact name is specified
826 if (pattern is not None and
828 and len(pattern.split(' ')) == 2):
831 return self._vessel_lookup(
832 vn, timestamp, dml=dml, create=create)
835 pattern_check = lambda vn: True
837 re = '(?:.* )?%s$' % pattern.lower().replace('*','.+')
838 pattern_check = regexp.compile(re, regexp.I).match
842 cmdr_pa = self._pl.get(cmdr, None)
843 if cmdr_pa: tries.append((cmdr_pa.v, 'cmdr'))
845 tries.append((self._v, 'here'))
848 for (v, dm) in tries:
849 if v is None: dml.append(dm+'?'); continue
852 if not pattern_check(vn):
860 if pattern is not None and '*' in pattern:
863 for (vn,v) in self._vl.iteritems()
864 if not self._vessel_stale(v, timestamp)
867 #debug('CLT-RE /%s/ wanted (%s) searched (%s)' % (
869 # '/'.join(tried_vns),
870 # '/'.join([vn for (vn,v) in search])))
880 def _debug_line_disposition(self,timestamp,l,m):
881 debug('CLT %13s %-40s %s' % (timestamp,m,l))
883 def _rm_crew_l(self,re,l):
884 m = regexp.match(re,l)
885 if m and m.group(2) == self._myself.crew[1]:
890 def local_command(self, metacmd):
891 # returns None if all went well, or problem message
892 return self._command(self._myself.name, metacmd,
893 "local", time.time(),
894 (lambda m: debug('CMD %s' % metacmd)))
896 def _command(self, cmdr, metacmd, chan, timestamp, d):
897 # returns None if all went well, or problem message
898 metacmd = regexp.sub('\\s+', ' ', metacmd).strip()
900 '/([adj]) (?:([A-Za-z* ]+)\\s*:)?([A-Za-z ]+)$',
902 if not m2: return "unknown syntax or command"
904 (cmd, pattern, targets) = m2.groups()
905 dml = ['cmd', chan, cmd]
907 if cmd == 'a': each = self._onboard_event
908 elif cmd == 'd': each = disembark
909 else: each = lambda *l: self._onboard_event(*l,
910 **{'jobber':'applied'})
912 if cmdr == self._myself.name:
914 how = 'cmd: %s' % cmd
917 how = 'cmd: %s %s' % (cmd,cmdr)
920 if pattern is not None:
921 return "/j command does not take a vessel"
924 v = self._find_matching_vessel(
925 pattern, timestamp, cmdr,
928 if cmd == 'j' or v is not None:
929 targets = targets.strip().split(' ')
930 dml.append(`len(targets)`)
931 for target in targets:
932 each(v, timestamp, target.title(), how)
933 self._vessel_updated(v, timestamp)
940 def chatline(self,l):
941 rm = lambda re: regexp.match(re,l)
942 d = lambda m: self._debug_line_disposition(timestamp,l,m)
943 rm_crew = lambda re: self._rm_crew_l(re,l)
946 m = rm('=+ (\\d+)/(\\d+)/(\\d+) =+$')
948 self._date = [int(x) for x in m.groups()]
949 self._previous_timestamp = None
950 return d('date '+`self._date`)
952 if self._date is None:
953 return d('date unset')
955 m = rm('\\[(\d\d):(\d\d):(\d\d)\\] ')
957 return d('no timestamp')
960 time_tuple = (self._date +
961 [int(x) for x in m.groups()] +
963 timestamp = time.mktime(time_tuple)
964 if timestamp >= self._previous_timestamp: break
966 self._debug_line_disposition(timestamp,'',
967 'new date '+`self._date`)
969 self._previous_timestamp = timestamp
971 l = l[l.find(' ')+1:]
973 def ob_x(pirate,event):
974 return self._onboard_event(
975 self._v, timestamp, pirate, event)
976 def ob1(did): ob_x(m.group(1), did); return d(did)
977 def oba(did): return ob1('%s %s' % (did, m.group(2)))
979 def jb(pirate,jobber):
980 return self._onboard_event(
981 None, timestamp, pirate,
982 ("jobber %s" % jobber),
986 def disembark(v, timestamp, pirate, event):
988 v, timestamp, pirate, 'leaving '+event)
992 def disembark_me(why):
993 self._disembark_myself()
994 return d('disembark-me '+why)
996 m = rm('Going aboard the (\\S.*\\S)\\.\\.\\.$')
999 pn = self._myself.name
1001 v = self._vessel_lookup(vn, timestamp, dm, create=True)
1002 self._lastvessel = self._vessel = vn
1004 ob_x(pn, 'we boarded')
1005 self.expire_garbage(timestamp)
1006 return d(' '.join(dm))
1009 return d('no vessel')
1011 m = rm('(\\w+) has come aboard\\.$')
1012 if m: return ob1('boarded');
1014 m = rm('You have ordered (\\w+) to do some (\\S.*\\S)\\.$')
1016 (who,what) = m.groups()
1017 pa = ob_x(who,'ord '+what)
1018 if what == 'Gunning':
1020 return d('duty order')
1022 m = rm('(\\w+) abandoned a (\\S.*\\S) station\\.$')
1023 if m: oba('stopped'); return d("end")
1025 def chat_core(speaker, chan):
1026 try: pa = self._pl[speaker]
1027 except KeyError: return 'mystery'
1028 if pa.v is not None and pa.v is not self._v:
1030 pa.last_chat_time = timestamp
1031 pa.last_chat_chan = chan
1032 self.force_redisplay()
1036 speaker = m.group(1)
1037 dm = chat_core(speaker, chan)
1038 return d('chat %s %s' % (chan, dm))
1040 def chat_metacmd(chan):
1041 (cmdr, metacmd) = m.groups()
1042 whynot = self._command(
1043 cmdr, metacmd, chan, timestamp, d)
1044 if whynot is not None:
1047 chat_core(cmdr, 'cmd '+chan)
1049 m = rm('(\\w+) (?:issued an order|ordered everyone) "')
1050 if m: return ob1('general order');
1052 m = rm('(\\w+) says, "')
1053 if m: return chat('public')
1055 m = rm('(\\w+) tells ye, "')
1056 if m: return chat('private')
1058 m = rm('Ye told (\\w+), "(.*)"$')
1059 if m: return chat_metacmd('private')
1061 m = rm('(\\w+) flag officer chats, "')
1062 if m: return chat('flag officer')
1064 m = rm('(\\w+) officer chats, "(.*)"$')
1065 if m: return chat_metacmd('officer')
1067 m = rm('Ye accepted the offer to job with ')
1068 if m: return disembark_me('jobbing')
1070 m = rm('Ye hop on the ferry and are whisked away ')
1071 if m: return disembark_me('ferry')
1073 m = rm('Whisking away to yer home on the magical winds')
1074 if m: return disembark_me('home')
1076 m = rm('Game over\\. Winners: ([A-Za-z, ]+)\\.$')
1078 pl = m.group(1).split(', ')
1079 if not self._myself.name in pl:
1080 return d('lost melee')
1082 if ' ' in pn: continue
1083 ob_x(pn,'won melee')
1084 return d('won melee')
1086 m = rm('(\\w+) is eliminated\\!')
1087 if m: return ob1('eliminated in fray');
1089 m = rm('(\\w+) has driven \w+ from the ship\\!')
1090 if m: return ob1('boarder repelled');
1092 m = rm('\w+ has bested (\\w+), and turns'+
1093 ' to the rest of the ship\\.')
1094 if m: return ob1('boarder unrepelled');
1096 pirate = rm_crew("(\\w+) has taken a job with '(.*)'\\.")
1097 if pirate: return jb(pirate, 'ashore')
1099 pirate = rm_crew("(\\w+) has left '(.*)'\\.")
1101 disembark(self._v, timestamp, pirate, 'left crew')
1102 return d('left crew')
1104 m = rm('(\w+) has applied for the posted job\.')
1105 if m: return jb(m.group(1), 'applied')
1107 pirate= rm_crew("(\\w+) has been invited to job for '(.*)'\\.")
1108 if pirate: return jb(pirate, 'invited')
1110 pirate = rm_crew("(\\w+) declined the job offer for '(.*)'\\.")
1111 if pirate: return jb(pirate, 'declined')
1113 m = rm('(\\w+) has left the vessel\.')
1116 disembark(self._v, timestamp, pirate, 'disembarked')
1117 return d('disembarked')
1119 return d('not-matched')
1121 def _str_pa(self, pn, pa):
1122 assert self._pl[pn] == pa
1123 s = ' '*20 + "%s %-*s %13s %-30s %13s %-20s %13s" % (
1124 (' ','G')[pa.gunner],
1125 max_pirate_namelen, pn,
1126 pa.last_time, pa.last_event,
1127 pa.last_chat_time, pa.last_chat_chan,
1129 if pa.expires is not None:
1130 s += " %-5d" % (pa.expires - pa.last_time)
1134 def _str_vessel(self, vn, v):
1135 s = ' vessel %s\n' % vn
1136 s += ' '*20 + "%-*s %13s\n" % (
1137 max_pirate_namelen, '#lastinfo',
1139 assert v['#name'] == vn
1140 for pn in sorted(v.keys()):
1141 if pn.startswith('#'): continue
1144 s += self._str_pa(pn,pa)
1148 s = '''<ChatLogTracker
1151 ''' % (self._myself.name, self._vessel)
1152 assert ((self._v is None and self._vessel is None) or
1153 (self._v is self._vl[self._vessel]))
1154 if self._vessel is not None:
1155 s += self._str_vessel(self._vessel, self._v)
1156 for vn in sorted(self._vl.keys()):
1157 if vn == self._vessel: continue
1158 s += self._str_vessel(vn, self._vl[vn])
1162 if pa.v is not None:
1163 assert pa.v[p] is pa
1164 assert pa.v in self._vl.values()
1166 s += self._str_pa(pa.name, pa)
1170 def catchup(self, progress=None):
1172 more = self._f.readline()
1175 self._progress[0] += len(more)
1176 if progress: progress.progress(*self._progress)
1179 if self._lbuf.endswith('\n'):
1180 self.chatline(self._lbuf.rstrip())
1183 debug(self.__str__())
1184 self._expire_jobbers(time.time())
1186 if progress: progress.caughtup()
1189 rv = self._need_redisplay
1190 self._need_redisplay = False
1193 # returns our pirate name
1194 return self._myself.name
1195 def vesselname(self):
1196 # returns the vessel name we're aboard or None
1198 def lastvesselname(self):
1199 # returns the last vessel name we were aboard or None
1200 return self._lastvessel
1201 def aboard(self, vesselname=True):
1202 # returns a list of PirateAboard the vessel
1203 # sorted by pirate name
1204 # you can pass this None and you'll get []
1205 # or True for the current vessel (which is the default)
1206 # the returned value is a fresh list of persistent
1207 # PirateAboard objects
1208 if vesselname is True: v = self._v
1209 else: v = self._vl.get(vesselname.title())
1210 if v is None: return []
1212 for pn in sorted(v.keys())
1213 if not pn.startswith('#') ]
1215 # returns a the jobbers' PirateAboards,
1216 # sorted by jobber class and reverse of expiry time
1218 for pa in self._pl.values()
1219 if pa.jobber is not None
1222 return (pa.jobber, -pa.expires)
1223 l.sort(key = compar_key)
1226 #---------- implementations of actual operation modes ----------
1228 def do_pirate(pirates, bu):
1230 for pirate in pirates:
1231 info = PirateInfo(pirate)
1232 print '%s: %s,' % (`pirate`, info)
1235 def prep_crew_of(args, bu, max_age=300):
1236 if len(args) != 1: bu('crew-of takes one pirate name')
1237 pi = PirateInfo(args[0], max_age)
1238 if pi.crew is None: return None
1239 return CrewInfo(pi.crew[0], max_age)
1241 def do_crew_of(args, bu):
1242 ci = prep_crew_of(args, bu)
1245 def do_flag_of(args, bu):
1246 if len(args) != 1: bu('flag-of takes one pirate name')
1248 pi = PirateInfo(args[0], max_age)
1249 if pi.flag is None: fi = None
1250 else: fi = FlagInfo(pi.flag[0], max_age)
1253 def do_standings_crew_of(args, bu):
1254 ci = prep_crew_of(args, bu, 60)
1255 tab = StandingsTable(sys.stdout)
1257 for (rank, members) in ci.crew:
1258 if not members: continue
1260 tab.literalline('%s:' % rank)
1262 pi = PirateInfo(p, random.randint(900,1800))
1265 def do_ocean(args, bu):
1266 if (len(args)): bu('ocean takes no further arguments')
1267 fetcher.default_ocean()
1270 for islename in sorted(oi.islands.keys()):
1271 isle = oi.islands[islename]
1272 yoweb_url = isle.yoweb_url()
1273 print " %s -- %s" % (islename, yoweb_url)
1275 #----- modes which use the chat log parser are quite complex -----
1277 class ProgressPrintPercentage:
1278 def __init__(self, f=sys.stdout):
1280 def progress_string(self,done,total):
1281 return "scan chat logs %3d%%\r" % ((done*100) / total)
1282 def progress(self,*a):
1283 self._f.write(self.progress_string(*a))
1285 def show_init(self, pirate, ocean):
1286 print >>self._f, 'Starting up, %s on the %s ocean' % (
1289 self._f.write(' \r')
1292 def prep_chat_log(args, bu,
1293 progress=ProgressPrintPercentage(),
1294 max_myself_age=3600):
1295 if len(args) != 1: bu('this action takes only chat log filename')
1297 logfn_re = '(?:.*/)?([A-Z][a-z]+)_([a-z]+)_'
1298 match = regexp.match(logfn_re, logfn)
1299 if not match: bu('chat log filename is not in expected format')
1300 (pirate, ocean) = match.groups()
1301 fetcher.default_ocean(ocean)
1303 progress.show_init(pirate, fetcher.ocean)
1304 myself = PirateInfo(pirate,max_myself_age)
1305 track = ChatLogTracker(myself, logfn)
1308 track.catchup(progress)
1311 track.force_redisplay()
1313 return (myself, track)
1315 def do_track_chat_log(args, bu):
1316 (myself, track) = prep_chat_log(args, bu)
1321 sleep(0.5 + 0.5 * random.random())
1323 #----- ship management aid -----
1325 class Display_dumb(ProgressPrintPercentage):
1327 ProgressPrintPercentage.__init__(self)
1330 def realstart(self):
1333 class Display_overwrite(ProgressPrintPercentage):
1335 ProgressPrintPercentage.__init__(self)
1337 null = file('/dev/null','w')
1338 curses.setupterm(fd=null.fileno())
1340 self._clear = curses.tigetstr('clear')
1342 self._debug('missing clear!')
1343 self.show = Display_dumb.show
1346 self._t = {'el':'', 'ed':''}
1347 if not self._init_sophisticated():
1348 for k in self._t.keys(): self._t[k] = ''
1349 self._t['ho'] = self._clear
1351 def _debug(self,m): debug('display overwrite: '+m)
1353 def _init_sophisticated(self):
1354 for k in self._t.keys():
1355 s = curses.tigetstr(k)
1357 self._t['ho'] = curses.tigetstr('ho')
1358 if not self._t['ho']:
1359 cup = curses.tigetstr('cup')
1360 self._t['ho'] = curses.tparm(cup,0,0)
1361 missing = [k for k in self._t.keys() if not self._t[k]]
1363 self.debug('missing '+(' '.join(missing)))
1368 w = sys.stdout.write
1369 def wti(k): w(self._t[k])
1373 for l in s.rstrip().split('\n'):
1382 def realstart(self):
1383 sys.stdout.write(self._clear)
1387 def do_ship_aid(args, bu):
1388 if opts.ship_duty is None: opts.ship_duty = True
1390 displayer = globals()['Display_'+opts.display]()
1392 (myself, track) = prep_chat_log(args, bu, progress=displayer)
1394 displayer.realstart()
1396 if os.isatty(0): kr_create = KeystrokeReader
1397 else: kr_create = DummyKeystrokeReader
1400 kreader = kr_create(0, 10)
1401 ship_aid_core(myself, track, displayer, kreader)
1406 class KeyBasedSorter:
1407 def compar_key_pa(self, pa):
1408 pi = pa.pirate_info()
1409 if pi is None: return None
1410 return self.compar_key(pi)
1411 def lsort_pa(self, l):
1412 l.sort(key = self.compar_key_pa)
1414 class NameSorter(KeyBasedSorter):
1415 def compar_key(self, pi): return pi.name
1416 def desc(self): return 'name'
1418 class SkillSorter(NameSorter):
1419 def __init__(self, relevant):
1420 self._want = frozenset(relevant.split('/'))
1422 for p in core_duty_puzzles:
1423 if isinstance(p,basestring): self._avoid.add(p)
1424 else: self._avoid |= set(p)
1425 self._avoid -= self._want
1426 self._desc = '%s' % relevant
1428 def desc(self): return self._desc
1430 def compar_key(self, pi):
1432 pi.standings.get(puz,-1)
1433 for puz in self._want
1436 -pi.standings.get(puz,standing_limit)
1437 for puz in self._avoid
1440 def negate(x): return -x
1441 debug('compar_key %s bw=%s ba=%s' % (pi.name, `best_want`,
1443 return (-best_want, map(negate, best_avoid), pi.name)
1445 def ship_aid_core(myself, track, displayer, kreader):
1448 vn = track.vesselname()
1449 if vn: return (vn, " on board the %s" % vn)
1450 vn = track.lastvesselname()
1451 if vn: return (vn, " ashore from the %s" % vn)
1452 return (None, " not on a vessel")
1455 if t is None: return ' ' * 22
1456 return " %-4s %-16s" % (format_time_interval(now - t),e)
1458 displayer.show(track.myname() + find_vessel()[1] + '...')
1471 (vn, vs) = find_vessel()
1474 if cliexec is not None:
1476 elif clierr is not None:
1477 s += 'Error: '+clierr
1478 elif clicmd is not None:
1481 s = track.myname() + vs
1482 s += " at %s" % time.strftime("%Y-%m-%d %H:%M:%S")
1487 tbl = StandingsTable(tbl_s)
1489 aboard = track.aboard(vn)
1490 sort.lsort_pa(aboard)
1492 jobbers = track.jobbers()
1494 if track.vesselname(): howmany = 'aboard: %2d' % len(aboard)
1497 tbl.headings(howmany, ' sorted by '+sort.desc())
1501 for pa in aboard + jobbers:
1502 if pa.jobber != last_jobber:
1503 last_jobber = pa.jobber
1505 tbl.literalline('jobbers '+last_jobber)
1507 pi = pa.pirate_info()
1510 if pa.gunner: xs += 'G '
1512 xs += timeevent(pa.last_time, pa.last_event)
1513 xs += timeevent(pa.last_chat_time, pa.last_chat_chan)
1516 tbl.pirate_dummy(pa.name, rotate_nya[0], xs)
1520 s += tbl_s.getvalue()
1524 if cliexec is not None:
1525 clierr = track.local_command("/"+cliexec.strip())
1531 rotate_nya = rotate_nya[1:3] + rotate_nya[0]
1534 if clierr is not None:
1538 if clicmd is not None:
1539 if k == '\r' or k == '\n':
1542 elif k == '\e' and clicmd != "":
1546 elif k == '\b' or k == '\177':
1547 clicmd = clicmd[ 0 : len(clicmd)-1 ]
1553 elif k == 'g': sort = SkillSorter('Gunning')
1554 elif k == 'c': sort = SkillSorter('Carpentry')
1555 elif k == 's': sort = SkillSorter('Sailing/Rigging')
1556 elif k == 'b': sort = SkillSorter('Bilging')
1557 elif k == 'n': sort = SkillSorter('Navigating')
1558 elif k == 'd': sort = SkillSorter('Battle Navigation')
1559 elif k == 't': sort = SkillSorter('Treasure Haul')
1560 elif k == 'a': sort = NameSorter()
1561 elif k == '/': clicmdbase = ""; clicmd = clicmdbase
1562 elif k == '+': clicmdbase = "a "; clicmd = clicmdbase
1563 else: pass # unknown key command
1565 #---------- individual keystroke input ----------
1567 class DummyKeystrokeReader:
1568 def __init__(self,fd,timeout_dummy): pass
1569 def stop(self): pass
1570 def getch(self): sleep(1); return None
1571 def info(self): return ' [noninteractive]'
1573 class KeystrokeReader(DummyKeystrokeReader):
1574 def __init__(self, fd, timeout_decisec=0):
1576 self._saved = termios.tcgetattr(fd)
1577 a = termios.tcgetattr(fd)
1578 a[3] &= ~(termios.ECHO | termios.ECHONL |
1579 termios.ICANON | termios.IEXTEN)
1580 a[6][termios.VMIN] = 0
1581 a[6][termios.VTIME] = timeout_decisec
1582 termios.tcsetattr(fd, termios.TCSANOW, a)
1584 termios.tcsetattr(self._fd, termios.TCSANOW, self._saved)
1587 byte = os.read(self._fd, 1)
1588 if not len(byte): return None
1593 #---------- main program ----------
1596 global opts, fetcher
1599 '''usage: .../yoweb-scrape [OPTION...] ACTION [ARGS...]
1601 yoweb-scrape [--ocean OCEAN ...] pirate PIRATE
1602 yoweb-scrape [--ocean OCEAN ...] crew-of PIRATE
1603 yoweb-scrape [--ocean OCEAN ...] standings-crew-of PIRATE
1604 yoweb-scrape [--ocean OCEAN ...] track-chat-log CHAT-LOG
1605 yoweb-scrape [options] ship-aid CHAT-LOG (must be .../PIRATE_OCEAN_chat-log*)
1607 display modes (for --display) apply to ship-aid:
1608 --display=dumb just print new information, scrolling the screen
1609 --display=overwrite use cursor motion, selective clear, etc. to redraw at top''')
1611 ao('-O','--ocean',dest='ocean', metavar='OCEAN', default=None,
1612 help='select ocean OCEAN')
1613 ao('--cache-dir', dest='cache_dir', metavar='DIR',
1614 default='~/.yoweb-scrape-cache',
1615 help='cache yoweb pages in DIR')
1616 ao('-D','--debug', action='count', dest='debug', default=0,
1617 help='enable debugging output')
1618 ao('--debug-fd', type='int', dest='debug_fd',
1619 help='write any debugging output to specified fd')
1620 ao('-q','--quiet', action='store_true', dest='quiet',
1621 help='suppress warning output')
1622 ao('--display', action='store', dest='display',
1623 type='choice', choices=['dumb','overwrite'],
1624 help='how to display ship aid')
1625 ao('--local-ypp-dir', action='store', dest='localhtml',
1626 help='get yppedia pages from local directory LOCALHTML'+
1627 ' instead of via HTTP')
1629 ao_jt = lambda wh, t: ao(
1630 '--timeout-sa-'+wh, action='store', dest='timeout_'+wh,
1631 default=t, help=('set timeout for expiring %s jobbers' % wh))
1632 ao_jt('applied', 120)
1633 ao_jt('invited', 120)
1634 ao_jt('declined', 30)
1635 ao_jt('ashore', 1800)
1637 ao('--ship-duty', action='store_true', dest='ship_duty',
1638 help='show ship duty station puzzles')
1639 ao('--all-puzzles', action='store_false', dest='ship_duty',
1640 help='show all puzzles, not just ship duty stations')
1642 ao('--min-cache-reuse', type='int', dest='min_max_age',
1643 metavar='SECONDS', default=60,
1644 help='always reuse cache yoweb data if no older than this')
1646 (opts,args) = pa.parse_args()
1650 print >>sys.stderr, copyright_info
1651 pa.error('need a mode argument')
1653 if opts.debug_fd is not None:
1654 opts.debug_file = os.fdopen(opts.debug_fd, 'w')
1656 opts.debug_file = sys.stdout
1659 mode_fn_name = 'do_' + mode.replace('_','#').replace('-','_')
1660 try: mode_fn = globals()[mode_fn_name]
1661 except KeyError: pa.error('unknown mode "%s"' % mode)
1664 opts.expire_age = max(3600, opts.min_max_age)
1666 opts.ship_reboard_clearout = 3600
1668 if opts.cache_dir.startswith('~/'):
1669 opts.cache_dir = os.getenv('HOME') + opts.cache_dir[1:]
1671 if opts.display is None:
1672 if ((opts.debug > 0 and opts.debug_fd is None)
1673 or not os.isatty(sys.stdout.fileno())):
1674 opts.display = 'dumb'
1676 opts.display = 'overwrite'
1678 fetcher = Fetcher(opts.ocean, opts.cache_dir)
1680 mode_fn(args[1:], pa.error)