chiark / gitweb /
WIP new class and ordering data
[ypp-sc-tools.db-live.git] / yarrg / Commods.pm
index 3ecb804..a405f75 100644 (file)
@@ -24,6 +24,7 @@ package Commods;
 use IO::File;
 use HTTP::Request::Common ();
 use POSIX;
+use LWP::UserAgent;
 
 use strict;
 use warnings;
@@ -35,13 +36,14 @@ BEGIN {
     @ISA         = qw(Exporter);
     @EXPORT      = qw(&parse_info_clientside &fetch_with_rsync
                      &parse_info_serverside &parse_info_serverside_ocean
-                     %oceans %commods %clients %routes %route_mysteries
+                     %oceans %commods %clients
                      %vessels %shotname2damage
                      &parse_pctb_commodmap %pctb_commodmap @pctb_commodmap
                      &get_our_version &check_tsv_line
                      &pipethrough_prep &pipethrough_run
                      &pipethrough_run_along &pipethrough_run_finish
-                     &pipethrough_run_gzip
+                     &pipethrough_run_gzip &http_useragent &version_core
+                     &http_useragent_string_map
                      &cgipostform &yarrgpostform &cgi_get_caller
                      &set_ctype_utf8 $masterinfoversion);
     %EXPORT_TAGS = ( );
@@ -49,12 +51,36 @@ BEGIN {
     @EXPORT_OK   = qw();
 }
 
-our $masterinfoversion= 2; # version we understand
+our $masterinfoversion= 2; # version we understand.
+#
+# To extend the source-info.txt format:
+#
+#    * Commods.pm:parse_info1
+#       add code to parse new version
+#
+#    * source-info.txt
+#       add new information
+#
+# If new data should NOT be in master-info.txt too:
+#
+#    * update-master-info:process_some_info
+#       check that code for converting source-info to master-info
+#       removes the extra info; add code to remove it if necessary
+#
+#    * db-idempotent-populate
+#       if database schema is extended, add code to copy data
+#
+# If new data DOES need to be in master-info.txt too:
+#
+#    * Commods.pm:$masterinfoversion
+#       increment
+#
+#    * update-master-info:process_some_info
+#       add code to convert new version to old, by removing
+#       extra info conditionally depending on version
 
 our %oceans; # eg $oceans{'Midnight'}{'Ruby'}{'Eta Island'}= $sources;
 our %clients; # eg $clients{'ypp-sc-tools'}= [ qw(last-page) ];
-our %routes; # eg $routes{'Midnight'}{'Orca'}{'Tinga'}= $sources  NB abbrevs!
-our %route_mysteries; # eg $route_mysteries{'Midnight'}{'Norse'}= 3
 our %vessels; # eg $vessels{'War Brig'}{Shot}='medium'
               #    $vessels{'War Brig'}{Volume}= 81000
               #    $vessels{'War Brig'}{Mass}= 54000
@@ -72,13 +98,20 @@ our (%pctb_commodmap,@pctb_commodmap);
 my %colours; # eg $colours{'c'}{'black'}= $sources
 my (@rawcm, @nocm); # eg $rawcm[0]='fine rum'; $rawcm[1]='fine %c cloth'
 
+my %colour_ordvals; # $colour_ordvals{'green'}= '30';
+my %commodclasses; # $commodclasses{'dye'}= '3';
+
 # IMPORTANT
 #  when extending the format of source-info in a non-backward
 #  compatible way, be sure to update update-master-info too.
 
-sub parse_info1 ($$) {
-    my ($mmfn,$src)= @_;
-    my $mm= new IO::File $mmfn, 'r' or die "$mmfn $!";
+sub parse_info1 ($$$) {
+    my ($mmfn,$src,$enoentok)= @_;
+    my $mm= new IO::File $mmfn, 'r';
+    if (!$mm) {
+       return if $enoentok && $!==&ENOENT;
+       die "$mmfn $!";
+    }
     my @ctx= ();
     while (<$mm>) {
        next if m/^\s*\#/;
@@ -86,11 +119,22 @@ sub parse_info1 ($$) {
        s/\s+$//;
        if (m/^\%(\w+)$/) {
            my $colourkind= $1;
-           @ctx= (sub { $colours{$colourkind}{lc $_} .= $src; });
+           @ctx= (sub {
+               m/^(\S[^\t@]+\S)(?:\t+\@(\d+))?$/ or die;
+               my ($colour,$order)=$1;
+               $colours{$colourkind}{$colour} .= $src;
+               $colour_ordvals{$colourkind}{$colour}= $order
+                   if defined $order;
+           });
        } elsif (m/^commods$/) {
            @ctx= (sub { push @rawcm, lc $_; });
        } elsif (m/^nocommods$/) {
            @ctx= (sub { push @nocm, lc $_; });
+       } elsif (m/^commodclasses$/) {
+           @ctx= (sub {
+               die unless m/^\*([-a-z]+)$/;
+               $commodclasses{$1}= scalar keys %commodclasses;
+           });
        } elsif (m/^ocean (\w+)$/) {
            my $ocean= $1;
            keys %{ $oceans{$ocean} };
@@ -105,28 +149,23 @@ sub parse_info1 ($$) {
            });
        } elsif (m/^vessels$/) {
            @ctx= (sub {
-               m/^ ([A-Z][a-z\ ]+[a-z]) \t\s*
-                   (small|medium|large) \t\s*
-                   (\d+) \s*\t\s*
-                   (\d+) $/x
+               return if m/^[-+|]+$/;
+               m/^ \| \s* ([A-Z][a-z\ ]+[a-z]) \s*
+                   \| \s* (small|medium|large) \s*
+                   \| \s* ([1-9][0-9,]+) \s*
+                   \| \s* ([1-9][0-9,]+) \s*
+                   \| $/x
                    or die;
-               $vessels{$1}= {
-                   Shot => $2,
-                   Volume => $3,
-                   Mass => $4,
-               };
+               my $name= $1;
+               my $v= { Shot => $2, Volume => $3, Mass => $4 };
+               foreach my $vm (qw(Volume Mass)) { $v->{$vm} =~ s/,//g; }
+               $vessels{$name}= $v;
            });
        } elsif (m/^shot$/) {
            @ctx= (sub {
                m/^ ([a-z]+) \s+ (\d+) $/x or die;
                $shotname2damage{$1}= $2;
            });
-       } elsif (m/^routes (\w+)$/) {
-           my $ocean= $1;
-           @ctx= (sub {
-               m/^(\S[^\t]*\S),\s*(\S[^\t]*\S),\s*([1-9][0-9]{0,2})$/ or die;
-               $routes{$ocean}{$1}{$2}= $3;
-           });
        } elsif (m/^client (\S+.*\S)$/) {
            my $client= $1;
            $clients{$client}= [ ];
@@ -151,64 +190,59 @@ sub parse_info1 ($$) {
     %commods= ();
     my $ca;
     $ca= sub {
-       my ($s,$ss) = @_;
+       my ($s,$ss,$ordbase) = @_;
 #print "ca($s)\n";
        if ($s !~ m/\%(\w+)/) {
            my ($name, $props) = $s =~
-               /^(\S[^\t]*\S)(?:\t+(\S[^\t]*\S))?$/
+               /^(\S[^\t]*\S)(?:\t+(\S.*\S))?$/
                or die "bad commodspec $s";
            return if grep { $name eq $_ } @nocm;
            my $ucname= ucfirst $name;
            $commods{$ucname}{Srcs} .= $ss;
            my $c= $commods{$ucname};
            $c->{Volume}= 1000;
+           my ($ordval, $ordclassval);
            foreach my $prop (defined $props ? split /\s+/, $props : ()) {
                if ($prop =~ m/^([1-9]\d*)(k?)g$/) {
                    $c->{Mass}= $1 * ($2 ? 1000 : 1);
-               } elsif ($prop =~m/^([1-9]\d*)l$/) {
+               } elsif ($prop =~ m/^([1-9]\d*)l$/) {
                    $c->{Volume}= $1 * 1000;
+               } elsif ($prop =~ m/^\*([-a-z]+)$/) {
+                   $c->{Class}= $1;
+                   die "$1" unless exists $commodclasses{$1};
+                   $ordclassval= $commodclasses{$1} * 10000;
+               } elsif ($prop =~ m/^\@(\d+)$/) {
+                   $ordval= $1;
                } else {
                    die "unknown property $prop for $ucname";
                }
            }
+           if (defined $ordbase && defined $ordval && defined $ordclassval) {
+               $ordval += $ordbase + $ordval + $ordclassval;
+               $c->{Ordval}= $ordval;
+#print STDERR "ordval $name $ordval\n";
+           } else {
+#print STDERR "ordval $name NONE\n";
+            }
            return;
        }
        die "unknown $&" unless defined $colours{$1};
        my ($lhs,$pctlet,$rhs)= ($`,$1,$');
        foreach my $c (keys %{ $colours{$pctlet} }) {
-           &$ca($lhs.$c.$rhs, $ss .'%'. $colours{$pctlet}{$c});
+           my $ordcolour= $colour_ordvals{$c};
+           &$ca($lhs.$c.$rhs,
+                $ss .'%'. $colours{$pctlet}{$c},
+                defined($ordbase) && defined($ordcolour)
+                    ? $ordbase+$ordcolour : undef);
        }
     };
-    foreach (@rawcm) { &$ca($_,$src); }
-
-    foreach my $on (keys %routes) {
-       my $routes= $routes{$on};
-       my $ocean= $oceans{$on};
-       die unless defined $ocean;
-       
-       my @allislands;
-       foreach my $an (sort keys %$ocean) {
-           my $arch= $ocean->{$an};
-           push @allislands, sort keys %$arch;
-       }
-       parse_info_maproutes($on, \@allislands, $routes);
-       foreach my $route (values %$routes) {
-           parse_info_maproutes($on, \@allislands, $route);
-       }
-    }
+    foreach (@rawcm) { &$ca($_,$src,0); }
 }
 
 sub parse_info_clientside () {
-    my $yarrg= $ENV{'YPPSC_YARRG_DICT_UPDATE'};
-    return unless $yarrg;
-    my $master= fetch_with_rsync("info-$masterinfoversion");
-    parse_info1($master,'s');
-    my $local= '_local-info.txt';
-    if (stat $local) {
-       parse_info1($local,'s');
-    } else {
-       die "$local $!" unless $! == &ENOENT;
-    }
+    my $master= fetch_with_rsync("info-v$masterinfoversion");
+    parse_info1($master,'s',1);
+    parse_info1('_local-info.txt','s',1);
 }
 
 sub fetch_with_rsync ($) {
@@ -227,28 +261,13 @@ sub fetch_with_rsync ($) {
     return $local;
 }
 
-sub parse_info_maproutes ($$$) {
-    my ($on, $allislands, $routemap) = @_;;
-    foreach my $k (sort keys %$routemap) {
-       my @ok= grep { index($_,$k) >= 0 } @$allislands;
-       die "ambiguous $k" if @ok>1;
-       if (!@ok) {
-           $route_mysteries{$on}{$k}++;
-           delete $routemap->{$k};
-       } elsif ($ok[0] ne $k) {
-           $routemap->{$ok[0]}= $routemap->{$k};
-           delete $routemap->{$k};
-       }
-    }
-}
-
 sub parse_info_serverside () {
-    parse_info1('source-info.txt','s');
+    parse_info1('source-info.txt','s',0);
 }
 sub parse_info_serverside_ocean ($) {
     my ($oceanname) = @_;
     die "unknown ocean $oceanname ?" unless exists $oceans{$oceanname};
-    parse_info1("_ocean-".(lc $oceanname).".txt",'s');
+    parse_info1("_ocean-".(lc $oceanname).".txt", 's',0);
 }
 
 sub parse_pctb_commodmap () {
@@ -273,16 +292,26 @@ sub get_our_version ($$) {
     my ($aref,$prefix) = @_;
     $aref->{"${prefix}name"}= 'ypp-sc-tools yarrg';
     $aref->{"${prefix}fixes"}= 'lastpage checkpager';
-
-    my $version= `git-describe --tags HEAD || echo 0unknown`; $? and die $?;
-    chomp($version);
-    $aref->{"${prefix}version"}= $version;
+    $aref->{"${prefix}version"}= version_core();
     return $aref;
     # clientname       "ypp-sc-tools"
     # clientversion    2.1-g2e06a26  [from git-describe --tags HEAD]
     # clientfixes      "lastpage"  [space separated list]
 }
 
+sub version_core () {
+    my $version= `
+       if type -p git-describe >/dev/null 2>&1; then
+               gd=git-describe
+       else
+               gd="git describe"
+       fi
+       \$gd --tags HEAD || echo 0unknown
+    `; $? and die $?;
+    chomp($version);
+    return $version;
+}
+
 sub pipethrough_prep () {
     my $tf= IO::File::new_tmpfile() or die $!;
     return $tf;
@@ -420,4 +449,22 @@ sub set_ctype_utf8 () {
     setlocale(LC_CTYPE, "en.UTF-8");
 }
 
+sub http_useragent_string_map ($$) {
+    my ($caller_lib_agent, $reason_style_or_caller) = @_;
+    $caller_lib_agent =~ y/A-Za-z/N-ZA-Mn-za-m/;
+    $caller_lib_agent =~ s/\s/_/g;
+    my $version= version_core();
+    return "yarrg/$version ($reason_style_or_caller)".
+          " $caller_lib_agent".
+          " (http://yarrg.chiark.net/intro)";
+}
+
+sub http_useragent ($) {
+    my ($who) = @_;
+    my $ua= LWP::UserAgent->new;
+    my $base= $ua->_agent();
+    $ua->agent(http_useragent_string_map($base, $who));
+    return $ua;
+}
+
 1;