chiark / gitweb /
Do not display number available in trading plan
[ypp-sc-tools.web-live.git] / yarrg / web / routetrade
index 4475d27..4dbe36e 100644 (file)
+<%doc>
+
+ This is part of the YARRG website.  YARRG is a tool and website
+ for assisting players of Yohoho Puzzle Pirates.
+
+ Copyright (C) 2009 Ian Jackson <ijackson@chiark.greenend.org.uk>
+ Copyright (C) 2009 Clare Boothby
+
+  YARRG's client code etc. is covered by the ordinary GNU GPL (v3 or later).
+  The YARRG website is covered by the GNU Affero GPL v3 or later, which
+   basically means that every installation of the website will let you
+   download the source.
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU Affero 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 Affero General Public License for more details.
+
+ You should have received a copy of the GNU Affero 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.
+
+
+ This Mason component is the core trade planner for a specific route.
+
+
+========== TODO ==========
+16:36 <ceb> alpha,byrne,papaya,turtle,jorvik,luthien is my example
+
+use POST for update.  Hrrm.
+
+LATER OR NOT AT ALL
+
+adjustable potential cost of losses (rather than fixed 1e-BIG per league)
+
+max volume/mass
+
+========== TODO ==========
+
+</%doc>
 <%args>
+$dbh
 @islandids
 @archipelagoes
+$qa
 </%args>
+<&| script &>
+  da_pageload= Date.now();
+</&script>
+
+<%perl>
+
+my $now= time;
+my $loss_per_league= 1e-7;
+
+my @flow_conds;
+my @query_params;
+
+my $sd_condition= sub {
+       my ($bs, $ix) = @_;
+       my $islandid= $islandids[$ix];
+       if (defined $islandid) {
+               return "${bs}.islandid = $islandid";
+       } else {
+               push @query_params, $archipelagoes[$ix];
+               return "${bs}_islands.archipelago = ?";
+       }
+};
+
+my %islandpair;
+# $islandpair{$a,$b}= [ $start_island_ix, $end_island_ix ]
+
+my $specific= !grep { !defined $_ } @islandids;
+my $confusing= 0;
+
+foreach my $src_i (0..$#islandids) {
+       my $src_isle= $islandids[$src_i];
+       my $src_cond= $sd_condition->('sell',$src_i);
+       my @dst_conds;
+       foreach my $dst_i ($src_i..$#islandids) {
+               my $dst_isle= $islandids[$dst_i];
+               my $dst_cond= $sd_condition->('buy',$dst_i);
+               if ($dst_i==$src_i and !defined $src_isle) {
+                       # we always want arbitrage, but mentioning an arch
+                       # once shouldn't produce intra-arch trades
+                       $dst_cond=
+                               "($dst_cond AND sell.islandid = buy.islandid)";
+               }
+               push @dst_conds, $dst_cond;
+
+               if ($specific && !$confusing &&
+                   # With a circular route, do not carry goods round the loop
+                   !($src_i==0 && $dst_i==$#islandids &&
+                     $src_isle == $islandids[$dst_i])) {
+                       if ($islandpair{$src_isle,$dst_isle}) {
+                               $confusing= 1;
+                       } else {
+                               $islandpair{$src_isle,$dst_isle}=
+                                       [ $src_i, $dst_i ];
+                       }
+               }
+       }
+       push @flow_conds, "$src_cond AND (
+                       ".join("
+                    OR ",@dst_conds)."
+               )";
+}
+
+my $stmt= "            
+       SELECT  sell_islands.islandname                         org_name,
+               sell_islands.islandid                           org_id,
+               sell.price                                      org_price,
+               sell.qty                                        org_qty_stall,
+               sell_stalls.stallname                           org_stallname,
+               sell.stallid                                    org_stallid,
+               sell_uploads.timestamp                          org_timestamp,
+               buy_islands.islandname                          dst_name,
+               buy_islands.islandid                            dst_id,
+               buy.price                                       dst_price,
+               buy.qty                                         dst_qty_stall,
+               buy_stalls.stallname                            dst_stallname,
+               buy.stallid                                     dst_stallid,
+               buy_uploads.timestamp                           dst_timestamp,
+".($qa->{ShowStalls} ? "
+               sell.qty                                        org_qty_agg,
+               buy.qty                                         dst_qty_agg,
+" : "
+               (SELECT sum(qty) FROM sell AS sell_agg
+                 WHERE sell_agg.commodid = commods.commodid
+                 AND   sell_agg.islandid = sell.islandid
+                 AND   sell_agg.price = sell.price)            org_qty_agg,
+               (SELECT sum(qty) FROM buy AS buy_agg
+                 WHERE buy_agg.commodid = commods.commodid
+                 AND   buy_agg.islandid = buy.islandid
+                 AND   buy_agg.price = buy.price)              dst_qty_agg,
+")."
+               commods.commodname                              commodname,
+               commods.commodid                                commodid,
+               commods.unitmass                                unitmass,
+               commods.unitvolume                              unitvolume,
+               dist                                            dist,
+               buy.price - sell.price                          unitprofit
+       FROM commods
+       JOIN sell ON commods.commodid = sell.commodid
+       JOIN buy  ON commods.commodid = buy.commodid
+       JOIN islands AS sell_islands ON sell.islandid = sell_islands.islandid
+       JOIN islands AS buy_islands  ON buy.islandid  = buy_islands.islandid
+       JOIN uploads AS sell_uploads ON sell.islandid = sell_uploads.islandid
+       JOIN uploads AS buy_uploads  ON buy.islandid  = buy_uploads.islandid
+       JOIN stalls  AS sell_stalls  ON sell.stallid  = sell_stalls.stallid
+       JOIN stalls  AS buy_stalls   ON buy.stallid   = buy_stalls.stallid
+       JOIN dists ON aiid = sell.islandid AND biid = buy.islandid
+       WHERE   (
+               ".join("
+          OR   ", @flow_conds)."
+       )
+         AND   buy.price > sell.price
+       ORDER BY org_name, dst_name, commodname, unitprofit DESC,
+                org_price, dst_price DESC,
+                org_stallname, dst_stallname
+     ";
+
+my $sth= $dbh->prepare($stmt);
+$sth->execute(@query_params);
+my @flows;
+
+my @cols= ({ NoSort => 1 });
+
+my $addcols= sub {
+       my $base= shift @_;
+       foreach my $name (@_) {
+               my $col= { Name => $name, %$base };
+               $col->{Numeric}=1 if !$col->{Text};
+               push @cols, $col;
+       }
+};
+
+if ($qa->{ShowStalls}) {
+       $addcols->({ Text => 1 }, qw(
+               org_name org_stallname
+               dst_name dst_stallname
+       ));
+} else {
+       $addcols->({Text => 1 }, qw(
+               org_name dst_name
+       ));
+}
+$addcols->({ Text => 1 }, qw(commodname));
+$addcols->({ DoReverse => 1 },
+       qw(     org_price org_qty_agg dst_price dst_qty_agg
+       ));
+$addcols->({ DoReverse => 1, SortColKey => 'MarginSortKey' },
+       qw(     Margin
+       ));
+$addcols->({ DoReverse => 1 },
+       qw(     unitprofit MaxQty
+               MaxCapital MaxProfit
+       ));
+
+</%perl>
+
+% if ($qa->{'debug'}) {
+<pre>
+<% $stmt |h %>
+<% join(' | ',@query_params) |h %>
+</pre>
+% }
+
+<& dumptable:start, qa => $qa, sth => $sth &>
+% {
+%   my $got;
+%   while ($got= $sth->fetchrow_hashref()) {
+<%perl>
+
+       my $f= $flows[$#flows];
+       if (    !$f ||
+               $qa->{ShowStalls} ||
+               grep { $f->{$_} ne $got->{$_} }
+                       qw(org_id org_price dst_id dst_price commodid)
+       ) {
+               # Make a new flow rather than adding to the existing one
+
+               $f= {
+                       Ix => scalar(@flows),
+                       Var => "f".@flows,
+                       %$got
+               };
+               $f->{"org_stallid"}= $f->{"dst_stallid"}= 'all'
+                       if !$qa->{ShowStalls};
+               push @flows, $f;
+       }
+       foreach my $od (qw(org dst)) {
+               $f->{"${od}Stalls"}{
+                       $got->{"${od}_stallname"}
+                   } =
+                       $got->{"${od}_qty_stall"}
+                   ;
+       }
+
+</%perl>
+<& dumptable:row, qa => $qa, sth => $sth, row => $f &>
+%    }
+<& dumptable:end, qa => $qa &>
+% }
+
+<%perl>
+foreach my $f (@flows) {
+
+       $f->{MaxQty}= $f->{'org_qty_agg'} < $f->{'dst_qty_agg'}
+               ? $f->{'org_qty_agg'} : $f->{'dst_qty_agg'};
+       $f->{MaxProfit}= $f->{MaxQty} * $f->{'unitprofit'};
+       $f->{MaxCapital}= $f->{MaxQty} * $f->{'org_price'};
 
-%# So, add code to do right thing here:
+       $f->{MarginSortKey}= sprintf "%d",
+               $f->{'dst_price'} * 10000 / $f->{'org_price'};
+       $f->{Margin}= sprintf "%3.1f%%",
+               $f->{'dst_price'} * 100.0 / $f->{'org_price'} - 100.0;
 
+       $f->{ExpectedUnitProfit}=
+               $f->{'dst_price'} * (1.0 - $loss_per_league) ** $f->{'dist'}
+               - $f->{'org_price'};
+
+       my @uid= $f->{commodid};
+       foreach my $od (qw(org dst)) {
+               push @uid,
+                       $f->{"${od}_id"},
+                       $f->{"${od}_price"};
+               push @uid,
+                       $f->{"${od}_stallid"}
+                               if $qa->{ShowStalls};
+       }
+       $f->{UidLong}= join '_', @uid;
+
+       my $base= 31;
+       my $cmpu= '';
+       map {
+               my $uue= $_;
+               my $first= $base;
+               do {
+                       my $this= $uue % $base;
+print STDERR "uue=$uue this=$this ";
+                       $uue -= $this;
+                       $uue /= $base;
+                       $this += $first;
+                       $first= 0;
+                       $cmpu .= chr($this + ($this < 26 ? ord('a') :
+                                             $this < 52 ? ord('A')-26
+                                                        : ord('0')-52));
+print STDERR " uue=$uue this=$this cmpu=$cmpu\n";
+die "$cmpu $uue ?" if length $cmpu > 20;
+               } while ($uue);
+               $cmpu;
+       } @uid;
+       $f->{UidShort}= $cmpu;
+
+       if ($qa->{'debug'}) {
+               my @outuid;
+               $_= $f->{UidShort};
+               my $mul;
+               while (m/./) {
+                       my $v= m/^[a-z]/ ? ord($&)-ord('a') :
+                              m/^[A-Z]/ ? ord($&)-ord('A')+26 :
+                              m/^[0-9]/ ? ord($&)-ord('0')+52 :
+                              die "$_ ?";
+                       if ($v >= $base) {
+                               push @outuid, 0;
+                               $v -= $base;
+                               $mul= 1;
+#print STDERR "(next)\n";
+                       }
+                       die "$f->{UidShort} $_ ?" unless defined $mul;
+                       $outuid[$#outuid] += $v * $mul;
+
+#print STDERR "$f->{UidShort}  $_  $&  v=$v  mul=$mul  ord()=".ord($&).
+#                      "[vs.".ord('a').",".ord('A').",".ord('0')."]".
+#                      "  outuid=@outuid\n";
+
+                       $mul *= $base;
+                       s/^.//;
+               }
+               my $recons_long= join '_', @outuid;
+               $f->{UidLong} eq $recons_long or
+                       die "$f->{UidLong} = $f->{UidShort} = $recons_long ?";
+       }
+
+       if (defined $qa->{"R$f->{UidShort}"} &&
+           !defined $qa->{"T$f->{UidShort}"}) {
+               $f->{Suppress}= 1;
+       }
+
+}
+</%perl>
+
+% my $optimise= $specific && !$confusing && @islandids>1;
+% if (!$optimise) {
+
+<p>
+% if (@islandids<=1) {
+Route is trivial.
+% }
+% if (!$specific) {
+Route contains archipelago(es), not just specific islands.
+% }
+% if ($confusing) {
+Route is complex - it visits the same island several times
+and isn't a simple loop.
+% }
+Therefore, optimal trade pattern not calculated.
+
+% } else { # ========== OPTMISATION ==========
+<%perl>
+
+my $cplex= "
+Maximize
+
+  totalprofit:
+                  ".(join " +
+                  ", map {
+                       sprintf "%.20f %s", $_->{ExpectedUnitProfit}, $_->{Var}
+                       } @flows)."
+
+Subject To
+";
+
+my %avail_csts;
+foreach my $flow (@flows) {
+       if ($flow->{Suppress}) {
+               $cplex .= "
+   $flow->{Var} = 0
+";
+               next;
+       }
+       foreach my $od (qw(org dst)) {
+               my $cstname= join '_', (
+                       'avail',
+                       $flow->{'commodid'},
+                       $od,
+                       $flow->{"${od}_id"},
+                       $flow->{"${od}_price"},
+                       $flow->{"${od}_stallid"},
+               );
+                       
+               push @{ $avail_csts{$cstname}{Flows} }, $flow->{Var};
+               $avail_csts{$cstname}{Qty}= $flow->{"${od}_qty_agg"};
+       }
+}
+foreach my $cstname (sort keys %avail_csts) {
+       my $c= $avail_csts{$cstname};
+       $cplex .= "
+   ".  sprintf("%-30s","$cstname:")." ".
+       join("+", @{ $c->{Flows} }).
+       " <= ".$c->{Qty}."\n";
+}
+
+$cplex.= "
+Bounds
+        ".(join "
+        ", map { "$_->{Var} >= 0" } @flows)."
+
+End
+";
+
+if ($qa->{'debug'}) {
+</%perl>
 <pre>
-Route is as follows:
+<% $cplex |h %>
+</pre>
+<%perl>
+}
 
+{
+       my $input= pipethrough_prep();
+       print $input $cplex or die $!;
+       my $output= pipethrough_run_along($input, undef, 'glpsol',
+               qw(glpsol --cpxlp /dev/stdin -o /dev/stdout));
+       print "<pre>\n" if $qa->{'debug'};
+       my $found_section= 0;
+       while (<$output>) {
+               print encode_entities($_) if $qa->{'debug'};
+               if (m/^\s*No\.\s+Column name\s+St\s+Activity\s/) {
+                       die if $found_section>0;
+                       $found_section= 1;
+                       next;
+               }
+               next unless $found_section==1;
+               next if m/^[- ]+$/;
+               if (!/\S/) {
+                       $found_section= 2;
+                       next;
+               }
+               my ($ix, $qty) =
+                       m/^\s*\d+\s+f(\d+)\s+\S+\s+(\d+)\s/ or die "$_ ?";
+               my $flow= $flows[$ix] or die;
+               $flow->{OptQty}= $qty;
+               $flow->{OptProfit}= $flow->{'unitprofit'} * $qty;
+               $flow->{OptCapital}= $flow->{OptQty} * $flow->{'org_price'};
+       }
+       print "</pre>\n" if $qa->{'debug'};
+       pipethrough_run_finish($output, 'glpsol');
+       die unless $found_section;
+};
+
+$addcols->({ DoReverse => 1 }, qw(
+               OptQty
+       ));
+$addcols->({ Total => 0, DoReverse => 1 }, qw(
+               OptCapital OptProfit
+       ));
+
+</%perl>
+
+% } # ========== OPTIMISATION ==========
+
+% my %ts_sortkeys;
+% {
+%      my $cdspan= $qa->{ShowStalls} ? ' colspan=2' : '';
+%      my $cdstall= $qa->{ShowStalls} ? '<th>Stall</th>' : '';
+<table id="trades" rules=groups>
+<colgroup span=1>
+<colgroup span=2>
+<% $qa->{ShowStalls} ? '<colgroup span=2>' : '' %>
+<colgroup span=1>
+<colgroup span=2>
+<colgroup span=2>
+<colgroup span=2>
+<colgroup span=3>
+%      if ($optimise) {
+<colgroup span=3>
+%      }
+<tr class="spong">
+<th>
+<th<% $cdspan %>>Collect
+<th<% $cdspan %>>Deliver
+<th>
+<th colspan=2>Collect
+<th colspan=2>Deliver
+<th colspan=2>Profit
+<th colspan=3>Max
+%      if ($optimise) {
+<th colspan=3>Planned
+%      }
+
+<tr>
+<th>
+<th>Island <% $cdstall %>
+<th>Island <% $cdstall %>
+<th>Commodity
+<th>Price
+<th>Qty
+<th>Price
+<th>Qty
+<th>Margin
+<th>Unit
+<th>Qty
+<th>Capital
+<th>Profit
+%      if ($optimise) {
+<th>Qty
+<th>Capital
+<th>Profit
+%      }
+% }
+
+<tr id="trades_sort">
+% foreach my $col (@cols) {
+<th>
+% }
+
+% foreach my $flowix (0..$#flows) {
+%      my $flow= $flows[$flowix];
+%      my $rowid= "id_row_$flow->{UidShort}";
+<tr id="<% $rowid %>" class="datarow<% $flowix & 1 %>">
+<td><input type=hidden   name=R<% $flow->{UidShort} %> value="">
+    <input type=checkbox name=T<% $flow->{UidShort} %> value=""
+       <% $flow->{Suppress} ? '' : 'checked' %> >
+%      foreach my $ci (1..$#cols) {
+%              my $col= $cols[$ci];
+%              my $v= $flow->{$col->{Name}};
+%              $col->{Total} += $v if defined $col->{Total};
+%              $v='' if !$col->{Text} && !$v;
+%              my $sortkey= $col->{SortColKey} ?
+%                      $flow->{$col->{SortColKey}} : $v;
+%              $ts_sortkeys{$ci}{$rowid}= $sortkey;
+<td <% $col->{Text} ? '' : 'align=right' %>><% $v |h %>
+%      }
+% }
+<tr id="trades_total">
+<th>
+<th colspan=2>Total
+% foreach my $ci (3..$#cols) {
+%      my $col= $cols[$ci];
+<td align=right>
+%      if (defined $col->{Total}) {
+<% $col->{Total} |h %>
+%      }
+% }
+</table>
+
+<& tabsort, cols => \@cols, table => 'trades', rowclass => 'datarow',
+       throw => 'trades_sort', tbrow => 'trades_total' &>
+<&| script &>
+  ts_sortkeys= <% to_json_protecttags(\%ts_sortkeys) %>;
+  function all_onload() {
+    ts_onload__trades();
+  }
+  window.onload= all_onload;
+</&script>
+
+<input type=submit name=update value="Update">
+
+% if ($optimise) { # ========== TRADING PLAN ==========
+%
+% my $iquery= $dbh->prepare('SELECT islandname FROM islands
+%                              WHERE islandid = ?');
+% my %da_ages;
+%
+<h1>Voyage trading plan</h1>
+<table>
 % foreach my $i (0..$#islandids) {
-%   my $islandid= $islandids[$i];
-%   my $archipelago= $archipelagoes[$i];
-%   $islandid= '<undef>' unless defined $islandid;
-%   $archipelago= '<undef>' unless defined $archipelago;
+<tr><td colspan=3><strong>
+%      $iquery->execute($islandids[$i]);
+%      my ($islandname) = $iquery->fetchrow_array();
+%      if (!$i) {
+Start at <% $islandname |h %>
+%      } else {
+Sail to <% $islandname |h %>
+%      }
+</strong>
+%    my $age_reported= 0;
+%    foreach my $od (qw(dst org)) {
+%      my $sign= $od eq 'dst' ? -1 : +1;
+%      my %todo;
+%      foreach my $f (@flows) {
+%              next if $f->{Suppress};
+%              next unless $f->{"${od}_id"} == $islandids[$i];
+%              next unless $f->{OptQty};
+%              my $price= $f->{"${od}_price"};
+%              my $stallname= $f->{"${od}_stallname"};
+%              my $todo= \$todo{ $f->{'commodname'},
+%                                (sprintf "%07d", $price),
+%                                $stallname };
+%              $$todo= { Qty => 0 } unless $$todo;
+%              $$todo->{'commodname'}= $f->{'commodname'};
+%              $$todo->{'stallname'}= $stallname;
+%              $$todo->{Price}= $price;
+%              $$todo->{Timestamp}= $f->{"${od}_timestamp"};
+%              $$todo->{Qty} += $f->{OptQty};
+%              $$todo->{Total}= $$todo->{Price} * $$todo->{Qty};
+%              $$todo->{Stalls}= $f->{"${od}Stalls"};
+%      }
+%      if (%todo && !$age_reported++) {
+%              my $age= $now - (values %todo)[0]->{Timestamp};
+%              my $cellid= "da_${i}";
+%              $da_ages{$cellid}= $age;
+<td colspan=3 align=right>\
+(Data age: <span id="<% $cellid %>"><% prettyprint_age($age) %></span>)
+%      }
+%      my $total= 0;
+%      my $dline= 0;
+%      foreach my $tkey (sort keys %todo) {
+%              my $t= $todo{$tkey};
+%              $total += $t->{Total};
+%              my $span= 0 + keys %{ $t->{Stalls} };
+%              my $td= "td rowspan=$span";
+<tr class="datarow<% $dline %>">
+<<% $td %>><% $od eq 'org' ? 'Collect' : 'Deliver' %>
+<<% $td %>><% $t->{'commodname'} |h %>
 %
-  islandid=<% $islandid |h %>  archipelago=<% $archipelago |h %>
+%              my @stalls= sort keys %{ $t->{Stalls} };
+%              my $pstall= sub {
+%                      my $name= $stalls[$_[0]];
+<td><% $name |h %>
+%              };
 %
+%              $pstall->(0);
+<<% $td %> align=right><% $t->{Price} |h %> poe ea.
+<<% $td %> align=right><% $t->{Qty} |h %> unit(s)
+<<% $td %> align=right><% $t->{Total} |h %> total
+%
+%              foreach my $stallix (1..$#stalls) {
+<tr class="datarow<% $dline %>">
+%                      $pstall->($stallix);
+%              }
+%
+%              $dline ^= 1;
+%      }
+%      if (%todo) {
+<tr>
+<td colspan=4><td align=right><% $od eq 'org' ? 'Outlay' : 'Proceeds' %>
+<td align=right><% $total |h %> total
+%      }
+%    }
 % }
-
-</pre>
+</table>
+<& query_age:dataages, id2age => \%da_ages &>
+%
+% } # ========== TRADING PLAN ==========
 
 <%init>
 use CommodsWeb;
-my $dbh= dbw_connect('Midnight');
+use Commods;
 </%init>