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.
26 use HTTP::Request::Common ();
35 our ($VERSION, @ISA, @EXPORT, @EXPORT_OK, %EXPORT_TAGS);
38 @EXPORT = qw(&parse_info_clientside &fetch_with_rsync
39 &parse_info_serverside &parse_info_serverside_ocean
40 %oceans %commods %clients
41 %vessels %shotname2damage
42 &parse_pctb_commodmap %pctb_commodmap @pctb_commodmap
43 &get_our_version &check_tsv_line
44 &pipethrough_prep &pipethrough_run
45 &pipethrough_run_along &pipethrough_run_finish
46 &pipethrough_run_gzip &http_useragent &version_core
47 &http_useragent_string_map
48 &cgipostform &yarrgpostform &cgi_get_caller
49 &set_ctype_utf8 $masterinfoversion
56 our $masterinfoversion= 2; # version we understand.
58 # To extend the source-info.txt format:
60 # * Commods.pm:parse_info1
61 # add code to parse new version
66 # If new data should NOT be in master-info.txt too:
68 # * update-master-info:process_some_info
69 # check that code for converting source-info to master-info
70 # removes the extra info; add code to remove it if necessary
72 # * db-idempotent-populate
73 # if database schema is extended, add code to copy data
75 # If new data DOES need to be in master-info.txt too:
77 # * Commods.pm:$masterinfoversion
80 # * update-master-info:process_some_info
81 # add code to convert new version to old, by removing
82 # extra info conditionally depending on version
84 our %oceans; # eg $oceans{'Midnight'}{'Ruby'}{'Eta Island'}= $sources;
85 our %clients; # eg $clients{'ypp-sc-tools'}= [ qw(last-page) ];
86 our %vessels; # eg $vessels{'War Brig'}{Shot}='medium'
87 # $vessels{'War Brig'}{Volume}= 81000
88 # $vessels{'War Brig'}{Mass}= 54000
89 our %shotname2damage; # eg $shotname2damage{'medium'}= 3;
91 # 's' = Special Circumstances; 'l' = local ; B = with Bleach
94 # eg $commods{'Fine black cloth'}{Srcs}= $sources;
95 # eg $commods{'Fine black cloth'}{Mass}= 700 [g]
96 # eg $commods{'Fine black cloth'}{Volume}= 1000 [ml]
98 our (%pctb_commodmap,@pctb_commodmap);
100 my %colours; # eg $colours{'c'}{'black'}= $sources
101 my (@rawcm, @nocm); # eg $rawcm[0]='fine rum'; $rawcm[1]='fine %c cloth'
104 # when extending the format of source-info in a non-backward
105 # compatible way, be sure to update update-master-info too.
107 sub parse_info1 ($$$) {
108 my ($mmfn,$src,$enoentok)= @_;
109 my $mm= new IO::File $mmfn, 'r';
111 return if $enoentok && $!==&ENOENT;
121 @ctx= (sub { $colours{$colourkind}{lc $_} .= $src; });
122 } elsif (m/^commods$/) {
123 @ctx= (sub { push @rawcm, lc $_; });
124 } elsif (m/^nocommods$/) {
125 @ctx= (sub { push @nocm, lc $_; });
126 } elsif (m/^ocean (\w+)$/) {
128 keys %{ $oceans{$ocean} };
130 $ocean or die; # ref to $ocean needed to work
133 keys %{ $oceans{$ocean}{$arch} };
135 $oceans{$ocean}{$arch}{$_} .= $src;
138 } elsif (m/^vessels$/) {
140 return if m/^[-+|]+$/;
141 m/^ \| \s* ([A-Z][a-z\ ]+[a-z]) \s*
142 \| \s* (small|medium|large) \s*
143 \| \s* ([1-9][0-9,]+) \s*
144 \| \s* ([1-9][0-9,]+) \s*
148 my $v= { Shot => $2, Volume => $3, Mass => $4 };
149 foreach my $vm (qw(Volume Mass)) { $v->{$vm} =~ s/,//g; }
152 } elsif (m/^shot$/) {
154 m/^ ([a-z]+) \s+ (\d+) $/x or die;
155 $shotname2damage{$1}= $2;
157 } elsif (m/^client (\S+.*\S)$/) {
159 $clients{$client}= [ ];
162 push @{ $clients{$client} }, $bug;
165 my $indent= length $&;
166 die "wrong indent $indent" unless defined $ctx[$indent-1];
167 &{ $ctx[$indent-1] }();
172 $mm->error and die $!;
175 #print Dumper(\%oceans);
176 #print Dumper(\@rawcm);
183 if ($s !~ m/\%(\w+)/) {
184 my ($name, $props) = $s =~
185 /^(\S[^\t]*\S)(?:\t+(\S[^\t]*\S))?$/
186 or die "bad commodspec $s";
187 return if grep { $name eq $_ } @nocm;
188 my $ucname= ucfirst $name;
189 $commods{$ucname}{Srcs} .= $ss;
190 my $c= $commods{$ucname};
192 foreach my $prop (defined $props ? split /\s+/, $props : ()) {
193 if ($prop =~ m/^([1-9]\d*)(k?)g$/) {
194 $c->{Mass}= $1 * ($2 ? 1000 : 1);
195 } elsif ($prop =~m/^([1-9]\d*)l$/) {
196 $c->{Volume}= $1 * 1000;
198 die "unknown property $prop for $ucname";
203 die "unknown $&" unless defined $colours{$1};
204 my ($lhs,$pctlet,$rhs)= ($`,$1,$');
205 foreach my $c (keys %{ $colours{$pctlet} }) {
206 &$ca($lhs.$c.$rhs, $ss .'%'. $colours{$pctlet}{$c});
209 foreach (@rawcm) { &$ca($_,$src); }
212 sub parse_info_clientside () {
213 my $master= fetch_with_rsync("info-v$masterinfoversion");
214 parse_info1($master,'s',1);
215 parse_info1('_local-info.txt','s',1);
218 sub fetch_with_rsync ($) {
221 my $rsync= $ENV{'YPPSC_YARRG_RSYNC'};
222 $rsync= 'rsync' if !defined $rsync;
224 my $local= "_master-$stem.txt";
225 my $src= $ENV{'YPPSC_YARRG_DICT_UPDATE'};
227 my $remote= "$src/master-$stem.txt";
228 $!=0; system 'rsync','-Lt','--',$remote,$local;
229 die "$? $!" if $! or $?;
234 sub parse_info_serverside () {
235 parse_info1('source-info.txt','s',0);
236 parse_info1('tree-info.txt','t',1);
238 sub parse_info_serverside_ocean ($) {
239 my ($oceanname) = @_;
240 die "unknown ocean $oceanname ?" unless exists $oceans{$oceanname};
241 parse_info1("_ocean-".(lc $oceanname).".txt", 's',0);
244 sub parse_pctb_commodmap () {
245 undef %pctb_commodmap;
246 foreach my $commod (keys %commods) { $commods{$commod}{Srcs} =~ s/b//; }
248 my $c= new IO::File '_commodmap.tsv';
249 if (!$c) { $!==&ENOENT or die $!; return 0; }
252 m/^(\S.*\S)\t(\d+)\n$/ or die "$_";
253 die if defined $pctb_commodmap{$1}; $pctb_commodmap{$1}= $2;
254 die if defined $pctb_commodmap[$2]; $pctb_commodmap[$2]= $1;
255 $commods{$1}{Srcs} .= 'b';
257 $c->error and die $!;
262 sub get_our_version ($$) {
263 my ($aref,$prefix) = @_;
264 $aref->{"${prefix}name"}= 'ypp-sc-tools yarrg';
265 $aref->{"${prefix}fixes"}= 'lastpage checkpager';
266 $aref->{"${prefix}version"}= version_core();
268 # clientname "ypp-sc-tools"
269 # clientversion 2.1-g2e06a26 [from git-describe --tags HEAD]
270 # clientfixes "lastpage" [space separated list]
273 sub version_core () {
275 if type -p git-describe >/dev/null 2>&1; then
280 \$gd --tags HEAD || echo 0unknown
286 sub pipethrough_prep () {
287 my $tf= IO::File::new_tmpfile() or die $!;
291 sub pipethrough_run_along ($$$@) {
292 my ($tf, $childprep, $cmd, @a) = @_;
293 $tf->error and die $!;
294 $tf->flush or die $!;
295 $tf->seek(0,0) or die $!;
296 my $fh= new IO::File;
297 my $child= $fh->open("-|"); defined $child or die $!;
299 open STDIN, "<&", $tf;
300 &$childprep() if defined $childprep;
301 exec $cmd @a; die "@a $!";
305 sub pipethrough_run_finish ($$) {
307 $fh->error and die $!;
308 close $fh or die "$what $! $?"; die $? if $?;
311 sub pipethrough_run ($$$@) {
312 my ($tf, $childprep, $cmd, @a) = @_;
313 my $pt= pipethrough_run_along($tf,$childprep,$cmd,@a);
315 { undef $/; $!=0; $r= <$pt>; }
316 defined $r or die $!;
317 pipethrough_run_finish($pt, "@a");
320 sub pipethrough_run_gzip ($) {
321 pipethrough_run($_[0],undef,'gzip','gzip');
324 sub yarrgpostform ($$) {
325 my ($ua, $form) = @_;
326 my $dest= $ENV{'YPPSC_YARRG_YARRG'};
327 get_our_version($form, 'client');
328 die unless $dest =~ m,/$,;
329 return cgipostform($ua, "${dest}commod-update-receiver", $form);
332 sub cgipostform ($$$) {
333 my ($ua, $url, $form) = @_;
334 my $req= HTTP::Request::Common::POST($url,
336 Content_Type => 'form-data');
337 if ($url =~ m,^\.?/,) {
338 my $tf= pipethrough_prep();
339 print $tf $req->content() or die $!;
340 #print STDERR "[[[",$req->content(),"]]]";
341 my $out= pipethrough_run($tf, sub {
342 $ENV{'REQUEST_METHOD'}= 'POST';
343 $ENV{'QUERY_STRING'}= '';
344 $ENV{'PATH_TRANSLATED'}= $url;
345 $ENV{'PATH_INFO'}= '';
346 $ENV{'HTTP_HOST'}= 'localhost';
347 $ENV{'REMOTE_ADDR'}= '127.0.0.1';
348 $ENV{'GATEWAY_INTERFACE'}= 'CGI/1.1';
349 $ENV{'DOCUMENT_ROOT'}= '.';
350 $ENV{'SCRIPT_FILENAME'}= $url;
351 $ENV{'SCRIPT_NAME'}= $url;
352 $ENV{'HTTP_USER_AGENT'}= 'Commods.pm local test';
354 foreach my $f (qw(Content_Length Content_Type)) {
355 $ENV{uc $f}= $req->header($f);
357 #system 'printenv >&2';
360 $out =~ m,^Content-Type: text/plain.*\n\n, or die "$out ?";
363 my $resp= $ua->request($req);
364 die $resp->status_line."\n".$resp->content."\n "
365 unless $resp->is_success;
366 return $resp->content();
372 sub check_tsv_line ($$) {
373 my ($l, $bad_data_callback) = @_;
374 my $bad_data= sub { &$bad_data_callback("bad data: line $.: $_[0]"); };
376 chomp($l) or &$bad_data('missing end-of-line');
378 $l !~ m/\P{IsPrint}/ or &$bad_data('nonprinting char(s)');
379 my @v= split /\t/, $l, -1;
380 @v==6 or &$bad_data('wrong number of fields');
381 my ($commod,$stall) = @v;
384 defined $commods{$commod} or
385 &$bad_data("unknown commodity \`$commod'");
387 $stall =~ m/^\p{IsUpper}|^[0-9]/ or &$bad_data("stall not capitalised");
388 !exists $check_tsv_done{$commod,$stall} or &$bad_data("repeated data");
389 $check_tsv_done{$commod,$stall}= 1;
390 foreach my $i (2..5) {
392 $f =~ m/^(|0|[1-9][0-9]{0,5}|\>1000)$/ or &$bad_data("bad field $i");
393 ($i % 2) or ($f !~ m/\>/) or &$bad_data("> in field $i price");
396 foreach my $i (2,4) {
397 &$bad_data("price with no qty or vice versa (field $i)")
398 if length($v[$i]) xor length($v[$i+1]);
400 length($v[2]) or length($v[4]) or
401 &$bad_data("commodity entry with no buy or sell offer");
406 sub cgi_get_caller () {
407 my $caller= $ENV{'REMOTE_ADDR'};
408 $caller= 'LOCAL' unless defined $caller;
410 my $fwdf= $ENV{'HTTP_X_FORWARDED_FOR'};
413 $fwdf =~ s/[^0-9.,]/?/g;
419 sub set_ctype_utf8 () {
420 setlocale(LC_CTYPE, "en.UTF-8");
423 sub http_useragent_string_map ($$) {
424 my ($caller_lib_agent, $reason_style_or_caller) = @_;
425 $caller_lib_agent =~ y/A-Za-z/N-ZA-Mn-za-m/;
426 $caller_lib_agent =~ s/\s/_/g;
427 my $version= version_core();
428 return "yarrg/$version ($reason_style_or_caller)".
429 " $caller_lib_agent".
430 " (http://yarrg.chiark.net/intro)";
433 sub http_useragent ($) {
435 my $ua= LWP::UserAgent->new;
436 my $base= $ua->_agent();
437 $ua->agent(http_useragent_string_map($base, $who));
441 sub source_tarball ($$) {
442 my ($sourcebasedir,$spitoutfn) = @_;
444 my $pipe= new IO::Pipe or die $!;
445 my $pid= fork(); defined $pid or die $!;
447 $ENV{'YPPSC_YARRG_SRCBASE'}= $sourcebasedir;
449 exec '/bin/sh','-c','
450 cd -P "$YPPSC_YARRG_SRCBASE"
453 git-ls-files -z --others --exclude-from=.gitignore;
454 if test -d .git; then find .git -print0; fi
456 cpio -Hustar -o --quiet -0 -R 1000:1000 || \
457 cpio -Hustar -o --quiet -0
465 while ($l= read $pipe, $d, 65536) {
469 defined $l or die "read pipe $!";
470 $pipe->error and die "pipe error $!";
472 # deliberately ignore errors