1 # This is part of ypp-sc-tools, a set of third-party tools for assisting
2 # players of Yohoho Puzzle Pirates.
4 # Copyright (C) 2009 Ian Jackson <ijackson@chiark.greenend.org.uk>
6 # This program is free software: you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation, either version 3 of the License, or
9 # (at your option) any later version.
11 # This program is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 # GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License
17 # along with this program. If not, see <http://www.gnu.org/licenses/>.
19 # Yohoho and Puzzle Pirates are probably trademarks of Three Rings and
20 # are used without permission. This program is not endorsed or
21 # sponsored by Three Rings.
25 use HTTP::Request::Common ();
33 our ($VERSION, @ISA, @EXPORT, @EXPORT_OK, %EXPORT_TAGS);
36 @EXPORT = qw(&parse_info_clientside &fetch_with_rsync
37 &parse_info_serverside &parse_info_serverside_ocean
38 %oceans %commods %clients %routes %route_mysteries
39 &parse_pctb_commodmap %pctb_commodmap @pctb_commodmap
40 &get_our_version &check_tsv_line
41 &pipethrough_prep &pipethrough_run
42 &pipethrough_run_along &pipethrough_run_finish
44 &cgipostform &yarrgpostform);
50 our %oceans; # eg $oceans{'Midnight'}{'Ruby'}{'Eta Island'}= $sources;
51 our %commods; # eg $commods{'Fine black cloth'}= $sources;
52 our %clients; # eg $clients{'ypp-sc-tools'}= [ qw(last-page) ];
53 our %routes; # eg $routes{'Midnight'}{'Orca'}{'Tinga'}= $sources NB abbrevs!
54 our %route_mysteries; # eg $route_mysteries{'Midnight'}{'Norse'}= 3
56 # 's' = Special Circumstances; 'l' = local ; B = with Bleach
58 our (%pctb_commodmap,@pctb_commodmap);
60 my %colours; # eg $colours{'c'}{'black'}= $sources
61 my @rawcm; # eg $rawcm[0]='fine rum'; $rawcm[1]='fine %c cloth'
63 sub parse_info1 ($$) {
65 my $mm= new IO::File $mmfn, 'r' or die "$mmfn $!";
73 @ctx= (sub { $colours{$colourkind}{lc $_} .= $src; });
74 } elsif (m/^commods$/) {
75 @ctx= (sub { push @rawcm, lc $_; });
76 } elsif (m/^ocean (\w+)$/) {
79 $ocean or die; # ref to $ocean needed to work
83 $oceans{$ocean}{$arch}{$_} .= $src;
86 } elsif (m/^routes (\w+)$/) {
89 m/^(\S[^\t]*\S),\s*(\S[^\t]*\S),\s*([1-9][0-9]{0,2})$/ or die;
90 $routes{$ocean}{$1}{$2}= $3;
92 } elsif (m/^client (\S+.*\S)$/) {
94 $clients{$client}= [ ];
97 push @{ $clients{$client} }, $bug;
100 my $indent= length $&;
101 die "wrong indent $indent" unless defined $ctx[$indent-1];
102 &{ $ctx[$indent-1] }();
107 $mm->error and die $!;
110 #print Dumper(\%oceans);
111 #print Dumper(\@rawcm);
118 if ($s !~ m/\%(\w+)/) { $commods{ucfirst $s} .= $ss; return; }
119 die "unknown $&" unless defined $colours{$1};
120 foreach my $c (keys %{ $colours{$1} }) {
121 &$ca($`.$c.$', $ss .'%'. $colours{$1}{$c});
124 foreach (@rawcm) { &$ca($_,$src); }
126 foreach my $on (keys %routes) {
127 my $routes= $routes{$on};
128 my $ocean= $oceans{$on};
129 die unless defined $ocean;
132 foreach my $an (sort keys %$ocean) {
133 my $arch= $ocean->{$an};
134 push @allislands, sort keys %$arch;
136 parse_info_maproutes($on, \@allislands, $routes);
137 foreach my $route (values %$routes) {
138 parse_info_maproutes($on, \@allislands, $route);
143 sub parse_info_clientside () {
144 my $yarrg= $ENV{'YPPSC_YARRG_DICT_UPDATE'};
145 return unless $yarrg;
146 my $master= fetch_with_rsync('info');
147 parse_info1($master,'s');
148 my $local= '_local-info.txt';
150 parse_info1($local,'s');
152 die "$local $!" unless $! == &ENOENT;
156 sub fetch_with_rsync ($) {
159 my $rsync= $ENV{'YPPSC_YARRG_RSYNC'};
160 $rsync= 'rsync' if !defined $rsync;
162 my $local= "_master-$stem.txt";
163 my $src= $ENV{'YPPSC_YARRG_DICT_UPDATE'};
165 my $remote= "$src/master-$stem.txt";
166 $!=0; system 'rsync','-Lt','--',$remote,$local;
167 die "$? $!" if $! or $?;
172 sub parse_info_maproutes ($$$) {
173 my ($on, $allislands, $routemap) = @_;;
174 foreach my $k (sort keys %$routemap) {
175 my @ok= grep { index($_,$k) >= 0 } @$allislands;
176 die "ambiguous $k" if @ok>1;
178 $route_mysteries{$on}{$k}++;
179 delete $routemap->{$k};
180 } elsif ($ok[0] ne $k) {
181 $routemap->{$ok[0]}= $routemap->{$k};
182 delete $routemap->{$k};
187 sub parse_info_serverside () {
188 parse_info1('master-info.txt','s');
190 sub parse_info_serverside_ocean ($) {
191 my ($oceanname) = @_;
192 die "unknown ocean $oceanname ?" unless exists $oceans{$oceanname};
193 parse_info1("ocean-".(lc $oceanname).".txt",'s');
196 sub parse_pctb_commodmap () {
197 undef %pctb_commodmap;
198 foreach my $commod (keys %commods) { $commods{$commod} =~ s/b//; }
200 my $c= new IO::File '_commodmap.tsv' or die $!;
201 if (!$c) { $!==&ENOENT or die $!; return 0; }
204 m/^(\S.*\S)\t(\d+)\n$/ or die "$_";
205 die if defined $pctb_commodmap{$1}; $pctb_commodmap{$1}= $2;
206 die if defined $pctb_commodmap[$2]; $pctb_commodmap[$2]= $1;
209 $c->error and die $!;
214 sub get_our_version ($$) {
215 my ($aref,$prefix) = @_;
216 $aref->{"${prefix}name"}= 'ypp-sc-tools yarrg';
217 $aref->{"${prefix}fixes"}= 'lastpage';
219 my $version= `git-describe --tags HEAD`; $? and die $?;
221 $aref->{"${prefix}version"}= $version;
225 sub pipethrough_prep () {
226 my $tf= IO::File::new_tmpfile() or die $!;
230 sub pipethrough_run_along ($$$@) {
231 my ($tf, $childprep, $cmd, @a) = @_;
232 $tf->flush or die $!;
233 $tf->seek(0,0) or die $!;
234 my $fh= new IO::File;
235 my $child= $fh->open("-|"); defined $child or die $!;
237 open STDIN, "<&", $tf;
238 &$childprep() if defined $childprep;
239 exec $cmd @a; die "@a $!";
243 sub pipethrough_run_finish ($$) {
245 $fh->error and die $!;
246 close $fh or die "$what $! $?"; die $? if $?;
249 sub pipethrough_run ($$$@) {
250 my ($tf, $childprep, $cmd, @a) = @_;
251 my $pt= pipethrough_run_along($tf,$childprep,$cmd,@a);
253 { undef $/; $!=0; $r= <$pt>; }
254 defined $r or die $!;
255 pipethrough_run_finish($pt, "@a");
258 sub pipethrough_run_gzip ($) {
259 pipethrough_run($_[0],undef,'gzip','gzip');
262 sub yarrgpostform ($$) {
263 my ($ua, $form) = @_;
264 my $dest= $ENV{'YPPSC_YARRG_YARRG'};
265 get_our_version($form, 'client');
266 die unless $dest =~ m,/$,;
267 return cgipostform($ua, "${dest}commod-update-receiver", $form);
270 sub cgipostform ($$$) {
271 my ($ua, $url, $form) = @_;
272 my $req= HTTP::Request::Common::POST($url,
274 Content_Type => 'form-data');
275 if ($url =~ m,^\.?/,) {
276 my $tf= pipethrough_prep();
277 print $tf $req->content() or die $!;
278 #print STDERR "[[[",$req->content(),"]]]";
279 my $out= pipethrough_run($tf, sub {
280 $ENV{'REQUEST_METHOD'}= 'POST';
281 $ENV{'QUERY_STRING'}= '';
282 $ENV{'PATH_TRANSLATED'}= $url;
283 $ENV{'PATH_INFO'}= '';
284 $ENV{'HTTP_HOST'}= 'localhost';
285 $ENV{'REMOTE_ADDR'}= '127.0.0.1';
286 $ENV{'GATEWAY_INTERFACE'}= 'CGI/1.1';
287 $ENV{'DOCUMENT_ROOT'}= '.';
288 $ENV{'SCRIPT_FILENAME'}= $url;
289 $ENV{'SCRIPT_NAME'}= $url;
290 $ENV{'HTTP_USER_AGENT'}= 'Commods.pm local test';
292 foreach my $f (qw(Content_Length Content_Type)) {
293 $ENV{uc $f}= $req->header($f);
295 #system 'printenv >&2';
298 $out =~ m,^Content-Type: text/plain.*\n\n, or die "$out ?";
301 my $resp= $ua->request($req);
302 die $resp->status_line unless $resp->is_success;
303 return $resp->content();
309 sub check_tsv_line ($$) {
310 my ($l, $bad_data_callback) = @_;
311 my $bad_data= sub { &$bad_data_callback("bad data: line $.: $_[0]"); };
313 chomp($l) or &$bad_data('missing end-of-line');
315 $l !~ m/\P{IsPrint}/ or &$bad_data('nonprinting char(s)');
316 my @v= split /\t/, $l, -1;
317 @v==6 or &$bad_data('wrong number of fields');
318 my ($commod,$stall) = @v;
321 defined $commods{$commod} or
322 &$bad_data("unknown commodity \`$commod'");
324 $stall =~ m/^\p{IsUpper}|^[0-9]/ or &$bad_data("stall not capitalised");
325 !exists $check_tsv_done{$commod,$stall} or &$bad_data("repeated data");
326 $check_tsv_done{$commod,$stall}= 1;
327 foreach my $i (2..5) {
329 $f =~ m/^(|0|[1-9][0-9]{0,5}|\>1000)$/ or &$bad_data("bad field $i");
330 ($i % 2) or ($f !~ m/\>/) or &$bad_data("> in field $i price");
333 foreach my $i (2,4) {
334 &$bad_data("price with no qty or vice versa (field $i)")
335 if length($v[$i]) xor length($v[$i+1]);
337 length($v[2]) or length($v[4]) or
338 &$bad_data("commodity entry with no buy or sell offer");
343 sub cgi_get_caller () {
344 my $caller= $ENV{'REMOTE_ADDR'};
345 $caller= 'LOCAL' unless defined $caller;
347 my $fwdf= $ENV{'HTTP_X_FORWARDED_FOR'};
350 $fwdf =~ s/[^0-9.,]/?/g;