chiark / gitweb /
Message confirmation loop thing
[ypp-sc-tools.web-live.git] / yarrg / yppedia-chart-parser
index fca7abd7f45652f783fa01b330e6ff05fe389f39..8eafa4cbf9293c78c278be570d8cbc12b751ba38 100755 (executable)
@@ -1,4 +1,33 @@
 #!/usr/bin/perl
+#
+# Normally run from
+#  update-master-info
+#
+# usage: ./yppedia-chart-parser <Oceanname>
+#  updates OCEAN-Oceanname.db and _ocean-<oceanname>.txt
+#  from YPPedia (chart and ocean page) and source-info.txt
+
+# This is part of ypp-sc-tools, a set of third-party tools for assisting
+# players of Yohoho Puzzle Pirates.
+#
+# Copyright (C) 2009 Ian Jackson <ijackson@chiark.greenend.org.uk>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+# Yohoho and Puzzle Pirates are probably trademarks of Three Rings and
+# are used without permission.  This program is not endorsed or
+# sponsored by Three Rings.
 
 use strict (qw(vars));
 use warnings;
@@ -7,9 +36,6 @@ use Graph::Undirected;
 use Commods;
 use CommodsDatabase;
 
-my $ocean= 'Midnight';
-
-
 my $widists= Graph::Undirected->new();
 my $wiarchs= Graph::Undirected->new();
 my $wispr;
@@ -20,20 +46,29 @@ my %winode2island;
 my %winode2lines;
 my %wiccix2arch;
 my $wialldists;
+my %wtisland2arch;
 
-my $dbdists= Graph::Undirected->new();
+my $dbdists;
 my %dbisland2arch;
 
+my @msgkinds= qw(change warning error);
 my %msgs;
+my %msgprinted;
+my %msgkindprinted;
 sub pmsg ($$) { push @{ $msgs{$_[0]} }, "$_[0]: $_[1]\n"; }
 sub warning ($) { pmsg("warning",$_[0]); }
 sub error   ($) { pmsg("error",  $_[0]); }
 sub change  ($) { pmsg("change", $_[0]); }
 sub print_messages () {
-    foreach my $k (qw(change warning error)) {
-       my $m= $msgs{$k};
-       next unless $m;
-       print sort @$m or die $!;
+    foreach my $k (@msgkinds) {
+       my $ms= $msgs{$k};
+       next unless $ms;
+       foreach my $m (sort @$ms) {
+           next if $msgprinted{$m};
+           print $m or die $!;
+           $msgprinted{$m}++;
+           $msgkindprinted{$k}++;
+       }
     }
 }
 sub progress ($) { print "($_[0])\n"; }
@@ -47,6 +82,11 @@ if (@ARGV && $ARGV[0] eq '--debug') {
 }
 select(STDOUT); $|=1;
 
+@ARGV==1 or die;
+$ARGV[0] =~ m/^\-/ and die;
+my $ocean= shift @ARGV;
+
+
 my $parity;
 sub nn_xy ($$) {
     my ($x,$y) = @_;
@@ -61,7 +101,7 @@ sub nn_xy ($$) {
 sub yppedia_chart_parse () {
     # We don't even bother with tag soup; instead we do line-oriented parsing.
 
-    while (<>) {
+    while (<OCEAN>) {
        s/\<--.*--\>//g;
        s/^\s*//; chomp; s/\s+$//; s/\s+/ /g;
        s/\<\/?(?:b|em)\>//g;
@@ -113,29 +153,6 @@ sub yppedia_chart_parse () {
     }
 }
 
-sub database_fetch_ocean () {
-    my ($row,$sth);
-    $sth= $dbh->prepare('SELECT islandname, archipelago FROM islands');
-    $sth->execute();
-    while ($row= $sth->fetchrow_hashref) {
-       print DEBUG "database-island $row->{'islandname'}".
-                    " $row->{'archipelago'}\n";
-       $dbisland2arch{$row->{'islandname'}}= $row->{'archipelago'};
-    }
-    $sth= $dbh->prepare('SELECT dist, a.islandname a, b.islandname b
-                               FROM dists
-                               JOIN islands AS a ON dists.aiid==a.islandid
-                               JOIN islands AS b ON dists.biid==b.islandid');
-    $sth->execute();
-    while ($row= $sth->fetchrow_hashref) {
-       $dbdists->add_weighted_edge($row->{'a'}, $row->{'b'}, $row->{'dist'});
-    }
-}                       
-
-sub database_graph_spr () {
-    $dbspr= shortest_path_reduction('db',$dbdists);
-}
-
 sub yppedia_graphs_add_shortcuts () {
     # We add edges between LPs we know about, as you can chart
     # between them.  Yppedia often lacks these edges.
@@ -187,12 +204,14 @@ sub yppedia_archs_sourceinfo () {
     foreach my $arch (sort keys %{ $oceans{$ocean} }) {
        foreach my $islename (sort keys %{ $oceans{$ocean}{$arch} }) {
            my $islenode= $wiisland2node{$islename};
-           defined $islenode or
+           if (!defined $islenode) {
                error("island $islename in source-info but not in WP map");
+               next;
+           }
            my $ccix= $wiarchs->connected_component_by_vertex($islenode);
            my $oldarch= $wiccix2arch{$ccix};
-           error("island $islename in $arch in source-info".
-                 " connected to $oldarch as well")
+           error("island in $arch in source-info".
+                 " connected to $oldarch as well: $islename")
                if defined $oldarch && $oldarch ne $arch;
            printf DEBUG "%-5s force-island-arch cc%-2d %-10s %s\n",
                $islenode, $ccix, $arch, $islename;
@@ -360,6 +379,15 @@ sub compare_island_lists () {
        }
     }
     foreach my $island (sort keys %wiisland2node) {
+       my $wtarch= $wtisland2arch{$island};
+       my $wiarch= wiisland2arch($island);
+       if (!defined $wtarch) {
+           error("island from chart not found on ocean page: $island");
+       } elsif (defined $wiarch and $wtarch ne $wiarch) {
+           error("island in $wtarch on ocean page but".
+                 " concluded $wiarch from chart: $island");
+       }
+
        my $dbarch= $dbisland2arch{$island};
        if (!defined $dbarch) {
            my $wiarch= wiisland2arch($island);
@@ -371,6 +399,11 @@ sub compare_island_lists () {
            change("island new in $wiarch: $island");
        }
     }
+    foreach my $island (sort keys %wtisland2arch) {
+       my $node= $wiisland2node{$island};
+       next if defined $node;
+       error("island on ocean page but not in chart: $island");
+    }
 }
 
 sub shortest_path_reduction ($$) {
@@ -499,6 +532,42 @@ sub yppedia_graph_spr () {
     $wispr= shortest_path_reduction('wi',$base);
 }
 
+sub yppedia_ocean_fetch_start ($) {
+    my ($chart) = @_;
+    my @args= ();
+    push @args, '--chart' if $chart;
+    push @args, $ocean;
+    open OCEAN, '-|', "./yppedia-ocean-scraper", @args or die $!;
+}
+sub yppedia_ocean_fetch_done () {
+    $?=0; $!=0; close OCEAN; $? and die $?; $! and die $!;
+}
+
+sub yppedia_ocean_fetch_chart () {
+    yppedia_ocean_fetch_start(1);
+    yppedia_chart_parse();
+    yppedia_ocean_fetch_done();
+}
+
+sub yppedia_ocean_fetch_text () {
+    yppedia_ocean_fetch_start(0);
+    my $arch;
+    while (<OCEAN>) {
+       chomp;
+       if (m/^ocean /) {
+           $' eq $ocean or die;
+       } elsif (m/^  /) {
+           die unless defined $arch;
+           $wtisland2arch{$'}= $arch;
+       } elsif (m/^ /) {
+           $arch= $';
+       } else {
+           die;
+       }
+    }
+    yppedia_ocean_fetch_done();
+}
+
 sub compare_distances () {
     foreach my $ia (sort keys %dbisland2arch) {
        my $na= $wiisland2node{$ia};
@@ -523,17 +592,38 @@ sub compare_distances () {
     }
 }
 
-parse_info_serverside();
+#========== database handling ==========
 
-progress("reading database");
+sub database_fetch_ocean () {
+    my ($row,$sth);
+    $sth= $dbh->prepare('SELECT islandname, archipelago FROM islands');
+    $sth->execute();
+    undef %dbisland2arch;
+    $dbdists= Graph::Undirected->new();
+    while ($row= $sth->fetchrow_hashref) {
+       print DEBUG "database-island $row->{'islandname'}".
+                    " $row->{'archipelago'}\n";
+       $dbisland2arch{$row->{'islandname'}}= $row->{'archipelago'};
+    }
+    $sth= $dbh->prepare('SELECT dist, a.islandname a, b.islandname b
+                               FROM dists
+                               JOIN islands AS a ON dists.aiid==a.islandid
+                               JOIN islands AS b ON dists.biid==b.islandid');
+    $sth->execute();
+    while ($row= $sth->fetchrow_hashref) {
+       $dbdists->add_weighted_edge($row->{'a'}, $row->{'b'}, $row->{'dist'});
+    }
+}                       
 
-db_setocean($ocean);
-db_connect();
-database_fetch_ocean();
+sub database_graph_spr () {
+    $dbspr= shortest_path_reduction('db',$dbdists);
+}
 
-progress("computing database spr");         database_graph_spr();
+#========== main program ==========
 
-progress("reading yppedia chart");          yppedia_chart_parse();
+parse_info_serverside();
+
+progress("fetching yppedia chart");         yppedia_ocean_fetch_chart();
 progress("adding shortcuts");               yppedia_graphs_add_shortcuts();
 progress("pruning boring vertices");        yppedia_graphs_prune_boring();
 progress("checking yppedia graphs");        yppedia_graphs_check();
@@ -542,8 +632,58 @@ progress("computing shortest paths");       yppedia_graph_shortest_paths();
 progress("setting archs from labels");      yppedia_archs_chart_labels();
 progress("setting archs from nearby");      yppedia_archs_fillbynearest();
 progress("computing yppedia spr");          yppedia_graph_spr();
+progress("fetching yppedia ocean text");    yppedia_ocean_fetch_text();
+
+db_setocean($ocean);
+db_connect();
+my $iteration=0;
+for (;;) {
+    progress("reading database");
+    database_fetch_ocean();
+    progress("computing database spr");         database_graph_spr();
+
+    progress("comparing islands");              compare_island_lists();
+    progress("comparing distances");            compare_distances();
+
+    print "\n";
+    print_messages();
+
+    foreach my $k (@msgkinds) {
+       my $n= $msgkindprinted{$k};
+       next unless $n;
+       printf STDERR "*** %d%s %ss\n", $n, $iteration?' additional':'', $k;
+    }
+    
+    if ($msgs{'error'}) {
+       print STDERR "*** errors, aborting update\n";
+       exit 1;
+    }
+
+    if (!%msgkindprinted) {
+       progress("updating database");         database_do_updates();
+       progress("updating _ocean-*.txt");     localtopo_rewrite();
+       progress("committing database");       $dbh->commit();
+       progress("committing _ocean-*.txt");   localtopo_commit();
+       exit 0;
+    }
+    $dbh->rollback();
+    
+    my $default= !$msgkindprinted{'warning'};
+    printf STDERR "*** confirm update %s ? ", $default?'(y/n)':'(n/y)';
+
+    $!=0; my $result= <STDIN>;  defined $result or die $!;
+    $result =~ s/\s//g;
+    $result= $default?'y':'n' if !length $result;
+    $result= $result =~ m/^y/i;
 
-progress("comparing islands");              compare_island_lists();
-progress("comparing distances");            compare_distances();
+    if (!$result) {
+       printf STDERR "*** updated abandoned at your request\n";
+       exit 1;
+    }
+
+    print "\n";
+    undef %msgkindprinted;
+    $iteration++;
+}
 
 print_messages();