3 This is part of the YARRG website. YARRG is a tool and website
4 for assisting players of Yohoho Puzzle Pirates.
6 Copyright (C) 2009 Ian Jackson <ijackson@chiark.greenend.org.uk>
7 Copyright (C) 2009 Clare Boothby
9 YARRG's client code etc. is covered by the ordinary GNU GPL (v3 or later).
10 The YARRG website is covered by the GNU Affero GPL v3 or later, which
11 basically means that every installation of the website will let you
14 This program is free software: you can redistribute it and/or modify
15 it under the terms of the GNU Affero General Public License as
16 published by the Free Software Foundation, either version 3 of the
17 License, or (at your option) any later version.
19 This program is distributed in the hope that it will be useful,
20 but WITHOUT ANY WARRANTY; without even the implied warranty of
21 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 GNU Affero General Public License for more details.
24 You should have received a copy of the GNU Affero General Public License
25 along with this program. If not, see <http://www.gnu.org/licenses/>.
27 Yohoho and Puzzle Pirates are probably trademarks of Three Rings and
28 are used without permission. This program is not endorsed or
29 sponsored by Three Rings.
32 This Mason component is the core trade planner for a specific route.
46 da_pageload= Date.now();
51 my $loss_per_league= defined $lossperleaguepct ? $lossperleaguepct*0.01 : 1e-7;
59 my $sd_condition= sub {
61 my $islandid= $islandids[$ix];
62 if (defined $islandid) {
63 return "${bs}.islandid = $islandid";
65 push @query_params, $archipelagoes[$ix];
66 return "${bs}_islands.archipelago = ?";
71 # $islandpair{$a,$b}= [ $start_island_ix, $end_island_ix ]
73 my $specific= !grep { !defined $_ } @islandids;
76 foreach my $src_i (0..$#islandids) {
77 my $src_isle= $islandids[$src_i];
78 my $src_cond= $sd_condition->('sell',$src_i);
80 foreach my $dst_i ($src_i..$#islandids) {
81 my $dst_isle= $islandids[$dst_i];
82 my $dst_cond= $sd_condition->('buy',$dst_i);
83 if ($dst_i==$src_i and !defined $src_isle) {
84 # we always want arbitrage, but mentioning an arch
85 # once shouldn't produce intra-arch trades
87 "($dst_cond AND sell.islandid = buy.islandid)";
89 push @dst_conds, $dst_cond;
91 if ($specific && !$confusing &&
92 # With a circular route, do not carry goods round the loop
93 !(($src_i==0 || $src_i==$#islandids) &&
94 $dst_i==$#islandids &&
95 $src_isle == $islandids[$dst_i])) {
96 if ($islandpair{$src_isle,$dst_isle}) {
98 print "confusing $src_i $src_isle $dst_i $dst_isle\n";
100 $islandpair{$src_isle,$dst_isle}=
105 push @flow_conds, "$src_cond AND (
112 SELECT sell_islands.islandname org_name,
113 sell_islands.islandid org_id,
114 sell.price org_price,
115 sell.qty org_qty_stall,
116 sell_stalls.stallname org_stallname,
117 sell.stallid org_stallid,
118 sell_uploads.timestamp org_timestamp,
119 buy_islands.islandname dst_name,
120 buy_islands.islandid dst_id,
122 buy.qty dst_qty_stall,
123 buy_stalls.stallname dst_stallname,
124 buy.stallid dst_stallid,
125 buy_uploads.timestamp dst_timestamp,
126 ".($qa->{ShowStalls} ? "
127 sell.qty org_qty_agg,
130 (SELECT sum(qty) FROM sell AS sell_agg
131 WHERE sell_agg.commodid = commods.commodid
132 AND sell_agg.islandid = sell.islandid
133 AND sell_agg.price = sell.price) org_qty_agg,
134 (SELECT sum(qty) FROM buy AS buy_agg
135 WHERE buy_agg.commodid = commods.commodid
136 AND buy_agg.islandid = buy.islandid
137 AND buy_agg.price = buy.price) dst_qty_agg,
139 commods.commodname commodname,
140 commods.commodid commodid,
141 commods.unitmass unitmass,
142 commods.unitvolume unitvolume,
144 buy.price - sell.price unitprofit
146 JOIN sell ON commods.commodid = sell.commodid
147 JOIN buy ON commods.commodid = buy.commodid
148 JOIN islands AS sell_islands ON sell.islandid = sell_islands.islandid
149 JOIN islands AS buy_islands ON buy.islandid = buy_islands.islandid
150 JOIN uploads AS sell_uploads ON sell.islandid = sell_uploads.islandid
151 JOIN uploads AS buy_uploads ON buy.islandid = buy_uploads.islandid
152 JOIN stalls AS sell_stalls ON sell.stallid = sell_stalls.stallid
153 JOIN stalls AS buy_stalls ON buy.stallid = buy_stalls.stallid
154 JOIN dists ON aiid = sell.islandid AND biid = buy.islandid
159 AND buy.price > sell.price
160 ORDER BY org_name, dst_name, commodname, unitprofit DESC,
161 org_price, dst_price DESC,
162 org_stallname, dst_stallname
165 my $sth= $dbh->prepare($stmt);
166 $sth->execute(@query_params);
169 my $distquery= $dbh->prepare("
170 SELECT dist FROM dists WHERE aiid = ? AND biid = ?
174 my $d= $dists{$from}{$to};
175 return $d if defined $d;
176 $distquery->execute($from,$to);
177 $d = $distquery->fetchrow_array();
178 defined $d or die "$from $to ?";
179 $dists{$from}{$to}= $d;
183 my @cols= ({ NoSort => 1 });
187 foreach my $name (@_) {
188 my $col= { Name => $name, %$base };
189 $col->{Numeric}=1 if !$col->{Text};
194 if ($qa->{ShowStalls}) {
195 $addcols->({ Text => 1 }, qw(
196 org_name org_stallname
197 dst_name dst_stallname
200 $addcols->({Text => 1 }, qw(
204 $addcols->({ Text => 1 }, qw(commodname));
205 $addcols->({ DoReverse => 1 },
206 qw( org_price org_qty_agg dst_price dst_qty_agg
208 $addcols->({ DoReverse => 1, SortColKey => 'MarginSortKey' },
211 $addcols->({ DoReverse => 1 },
212 qw( unitprofit MaxQty MaxCapital MaxProfit dist
214 foreach my $v (qw(MaxMass MaxVolume)) {
216 DoReverse => 1, Total => 0, SortColKey => "${v}SortKey" }, $v);
221 % if ($qa->{'debug'}) {
224 <% join(' | ',@query_params) |h %>
228 <& dumptable:start, qa => $qa, sth => $sth &>
231 % while ($got= $sth->fetchrow_hashref()) {
234 my $f= $flows[$#flows];
237 grep { $f->{$_} ne $got->{$_} }
238 qw(org_id org_price dst_id dst_price commodid)
240 # Make a new flow rather than adding to the existing one
243 Ix => scalar(@flows),
247 $f->{"org_stallid"}= $f->{"dst_stallid"}= 'all'
248 if !$qa->{ShowStalls};
251 foreach my $od (qw(org dst)) {
253 $got->{"${od}_stallname"}
255 $got->{"${od}_qty_stall"}
260 <& dumptable:row, qa => $qa, sth => $sth, row => $f &>
262 <& dumptable:end, qa => $qa &>
270 print 'No profitable trading opportunities were found.';
274 foreach my $f (@flows) {
276 $f->{MaxQty}= $f->{'org_qty_agg'} < $f->{'dst_qty_agg'}
277 ? $f->{'org_qty_agg'} : $f->{'dst_qty_agg'};
278 $f->{MaxProfit}= $f->{MaxQty} * $f->{'unitprofit'};
279 $f->{MaxCapital}= $f->{MaxQty} * $f->{'org_price'};
281 $f->{MaxMassSortKey}= $f->{MaxQty} * $f->{'unitmass'};
282 $f->{MaxVolumeSortKey}= $f->{MaxQty} * $f->{'unitvolume'};
283 foreach my $v (qw(Mass Volume)) {
284 $f->{"Max$v"}= sprintf "%.1f", $f->{"Max${v}SortKey"} * 1e-6;
287 $f->{MarginSortKey}= sprintf "%d",
288 $f->{'dst_price'} * 10000 / $f->{'org_price'};
289 $f->{Margin}= sprintf "%3.1f%%",
290 $f->{'dst_price'} * 100.0 / $f->{'org_price'} - 100.0;
292 $f->{ExpectedUnitProfit}=
293 $f->{'dst_price'} * (1.0 - $loss_per_league) ** $f->{'dist'}
296 $dists{'org_id'}{'dst_id'}= $f->{'dist'};
298 my @uid= $f->{commodid};
299 foreach my $od (qw(org dst)) {
304 $f->{"${od}_stallid"}
305 if $qa->{ShowStalls};
307 $f->{UidLong}= join '_', @uid;
315 my $this= $uue % $base;
316 print STDERR "uue=$uue this=$this ";
321 $cmpu .= chr($this + ($this < 26 ? ord('a') :
322 $this < 52 ? ord('A')-26
324 print STDERR " uue=$uue this=$this cmpu=$cmpu\n";
325 die "$cmpu $uue ?" if length $cmpu > 20;
329 $f->{UidShort}= $cmpu;
331 if ($qa->{'debug'}) {
336 my $v= m/^[a-z]/ ? ord($&)-ord('a') :
337 m/^[A-Z]/ ? ord($&)-ord('A')+26 :
338 m/^[0-9]/ ? ord($&)-ord('0')+52 :
344 #print STDERR "(next)\n";
346 die "$f->{UidShort} $_ ?" unless defined $mul;
347 $outuid[$#outuid] += $v * $mul;
349 #print STDERR "$f->{UidShort} $_ $& v=$v mul=$mul ord()=".ord($&).
350 # "[vs.".ord('a').",".ord('A').",".ord('0')."]".
351 # " outuid=@outuid\n";
356 my $recons_long= join '_', @outuid;
357 $f->{UidLong} eq $recons_long or
358 die "$f->{UidLong} = $f->{UidShort} = $recons_long ?";
361 if (defined $qa->{"R$f->{UidShort}"} &&
362 !defined $qa->{"T$f->{UidShort}"}) {
369 % my $optimise= $specific && !$confusing && @islandids>1;
373 % if (@islandids<=1) {
374 Route contains only one location.
377 Route contains archipelago(es), not just specific islands.
380 Route is complex - it visits the same island several times
381 and isn't a simple loop.
383 Therefore, optimal voyage trade plan not calculated.
385 % } else { # ========== OPTMISATION ==========
394 sprintf "%+.20f %s", $_->{ExpectedUnitProfit}, $_->{Var}
401 foreach my $flow (@flows) {
402 if ($flow->{Suppress}) {
408 foreach my $od (qw(org dst)) {
409 my $cstname= join '_', (
414 $flow->{"${od}_price"},
415 $flow->{"${od}_stallid"},
418 push @{ $avail_csts{$cstname}{Flows} }, $flow->{Var};
419 $avail_csts{$cstname}{Qty}= $flow->{"${od}_qty_agg"};
422 foreach my $cstname (sort keys %avail_csts) {
423 my $c= $avail_csts{$cstname};
425 ". sprintf("%-30s","$cstname:")." ".
426 join("+", @{ $c->{Flows} }).
427 " <= ".$c->{Qty}."\n";
430 foreach my $ci (0..($#islandids-1)) {
432 foreach my $f (@flows) {
433 next if $f->{Suppress};
434 next if $f->{'org_id'} == $f->{'dst_id'};
435 next unless grep { $f->{'org_id'} == $_ }
437 next unless grep { $f->{'dst_id'} == $_ }
438 @islandids[$ci+1..@islandids-1];
440 #print " RELEVANT $ci $f->{Ix} ";
442 #print " RELEVANT $ci COUNT ".scalar(@rel_flows)." ";
443 next unless @rel_flows;
444 foreach my $mv (qw(mass volume)) {
445 my $max_vn= "max_$mv";
446 my $max= $mv eq 'mass' ? $max_mass : $max_volume;
447 $max= 1e9 unless defined $max;
448 #print " DEFINED MAX $mv $max ";
450 ". sprintf("%-10s","${mv}_$ci:")." ".
451 join(" + ", map { ($_->{"unit$mv"}*1e-3).' f'.$_->{Ix} } @rel_flows).
460 ", map { "$_->{Var} >= 0" } @flows)."
467 ", map { "f$_" } (0..$#flows))."
472 if ($qa->{'debug'}) {
481 my $input= pipethrough_prep();
482 print $input $cplex or die $!;
483 my $output= pipethrough_run_along($input, undef, 'glpsol',
484 qw(glpsol --cpxlp /dev/stdin -o /dev/stdout));
485 print "<pre>\n" if $qa->{'debug'};
486 my $found_section= 0;
491 print encode_entities($_) if $qa->{'debug'};
492 if (m/^\s*No\.\s+(Row|Column) name\s+(?:St\s+)?Activity\s/) {
493 die "$_ $found_section ?" if $found_section>0;
497 next unless $found_section==1;
498 if (!length $continuation) {
499 next if !$continuation && m/^[- ]+$/;
504 if (m/^ \s* \d+ \s+ \w+ $/x) {
509 $_= $continuation.$_;
511 my ($varname, $qty) = m/^
513 (\w+) \s+ (?: [A-Z*]+ \s+ )?
516 if ($varname =~ m/^f(\d+)$/) {
518 my $flow= $flows[$ix] or die;
519 $flow->{OptQty}= $qty;
520 $flow->{OptProfit}= $flow->{'unitprofit'} * $qty;
521 $flow->{OptCapital}= $flow->{OptQty} *
522 $flow->{'org_price'};
523 } elsif ($varname =~ m/^(mass|volume)_(\d+)$/) {
524 my ($mv,$ix) = ($1,$2);
525 $total_massvol[$ix]{$mv}= $qty;
528 print "</pre>\n" if $qa->{'debug'};
529 my $prerr= "\n=====\n$cplex\n=====\n$glpsol_out\n=====\n ";
530 pipethrough_run_finish($output,$prerr);
531 map { defined $_->{OptQty} or die "$prerr $_->{Ix}" } @flows;
533 # die $prerr if grep { ! } @flows;
535 # die $prerr if map {
538 $addcols->({ DoReverse => 1, Special => sub {
539 my ($flow,$col,$v,$spec) = @_;
540 if ($flow->{ExpectedUnitProfit} < 0) {
542 $spec->{String}= '(Small margin)';
543 $spec->{Align}= 'align=center';
548 $addcols->({ Total => 0, DoReverse => 1 }, qw(
554 % } # ========== OPTIMISATION ==========
558 % my $cdspan= $qa->{ShowStalls} ? ' colspan=2' : '';
559 % my $cdstall= $qa->{ShowStalls} ? '<th>Stall</th>' : '';
560 <table id="trades" rules=groups>
563 <% $qa->{ShowStalls} ? '<colgroup span=2>' : '' %>
575 <th<% $cdspan %>>Collect
576 <th<% $cdspan %>>Deliver
578 <th colspan=2>Collect
579 <th colspan=2>Deliver
585 <th colspan=3>Planned
590 <th>Island <% $cdstall %>
591 <th>Island <% $cdstall %>
612 <tr id="trades_sort">
613 % foreach my $col (@cols) {
617 % foreach my $flowix (0..$#flows) {
618 % my $flow= $flows[$flowix];
619 % my $rowid= "id_row_$flow->{UidShort}";
620 <tr id="<% $rowid %>" class="datarow<% $flowix & 1 %>">
621 <td><input type=hidden name=R<% $flow->{UidShort} %> value="">
622 <input type=checkbox name=T<% $flow->{UidShort} %> value=""
623 <% $flow->{Suppress} ? '' : 'checked' %> >
625 % while ($ci < @cols) {
626 % my $col= $cols[$ci];
629 % Align => ($col->{Text} ? '' : 'align=right')
631 % my $v= $flow->{$col->{Name}};
632 % if ($col->{Special}) { $col->{Special}($flow,$col,$v,$spec); }
633 % $col->{Total} += $v
634 % if defined $col->{Total} and not $flow->{Suppress};
635 % $v='' if !$col->{Text} && !$v;
636 % my $sortkey= $col->{SortColKey} ?
637 % $flow->{$col->{SortColKey}} : $v;
638 % $ts_sortkeys{$ci}{$rowid}= $sortkey;
639 <td <% $spec->{Span} ? "colspan=$spec->{Span}" : ''
641 %>><% exists $spec->{String} ? $spec->{String} : $v |h %>
642 % $ci += $spec->{Span};
645 <tr id="trades_total">
648 % foreach my $ci (3..$#cols) {
649 % my $col= $cols[$ci];
651 % if (defined $col->{Total}) {
652 <% $col->{Total} |h %>
657 <&| tabsort, cols => \@cols, table => 'trades', rowclass => 'datarow',
658 throw => 'trades_sort', tbrow => 'trades_total' &>
659 ts_sortkeys= <% to_json_protecttags(\%ts_sortkeys) %>;
662 <input type=submit name=update value="Update">
664 % if ($optimise) { # ========== TRADING PLAN ==========
666 % my $iquery= $dbh->prepare('SELECT islandname FROM islands
667 % WHERE islandid = ?');
669 % my $total_total= 0;
672 <h1>Voyage trading plan</h1>
674 % foreach my $i (0..$#islandids) {
677 % $iquery->execute($islandids[$i]);
678 % my ($islandname) = $iquery->fetchrow_array();
680 <strong>Start at <% $islandname |h %></strong>
682 % my $this_dist= $distance->($islandids[$i-1],$islandids[$i]);
683 % $total_dist += $this_dist;
684 <strong>Sail to <% $islandname |h %></strong>
685 - <% $this_dist |h %> leagues </td>
690 foreach my $od (qw(org dst)) {
691 foreach my $f (@flows) {
692 next if $f->{Suppress};
693 next unless $f->{"${od}_id"} == $islandids[$i];
694 next unless $f->{OptQty};
695 my $arbitrage= $f->{'org_id'} == $f->{'dst_id'};
696 my $loop= $islandids[0] == $islandids[-1] &&
697 ($i==0 || $i==$#islandids);
698 next if $loop and ($arbitrage ? $i :
699 !!$i == !!($od eq 'org'));
700 my $price= $f->{"${od}_price"};
701 my $stallname= $f->{"${od}_stallname"};
702 my $todo= \$flowlists{$od}{
704 (sprintf "%07d", ($od eq 'dst' ?
705 9999999-$price : $price)),
713 $$todo->{'commodname'}= $f->{'commodname'};
714 $$todo->{'stallname'}= $stallname;
715 $$todo->{Price}= $price;
716 $$todo->{Timestamp}= $f->{"${od}_timestamp"};
717 $$todo->{Qty} += $f->{OptQty};
718 $$todo->{Total}= $$todo->{Price} * $$todo->{Qty};
719 $$todo->{Stalls}= $f->{"${od}Stalls"};
720 $$todo->{"${od}Arbitrage"}= 1 if $arbitrage;
724 my ($total, $total_to_show);
726 my $show_total= sub {
727 my ($totaldesc, $sign) = @_;
728 if (defined $total) {
729 die if defined $total_to_show;
730 $total_total += $sign * $total;
731 $total_to_show= [ $totaldesc, $total ];
736 my $show_total_now= sub {
738 return unless defined $total_to_show;
739 my ($totaldesc,$totalwas) = @$total_to_show;
743 <td colspan=2><% $xinfo %>
744 <td colspan=2 align=right><% $totaldesc %>
745 <td align=right><% $totalwas |h %> total
747 $total_to_show= undef;
750 % my $show_flows= sub {
751 % my ($od,$arbitrage,$collectdeliver) = @_;
752 % my $todo= $flowlists{$od};
753 % return unless $todo;
754 % foreach my $tkey (sort keys %$todo) {
755 % my $t= $todo->{$tkey};
756 % next if $t->{"${od}Arbitrage"} != $arbitrage;
757 % $show_total_now->('');
758 % if (!$age_reported++) {
759 % my $age= $now - $t->{Timestamp};
760 % my $cellid= "da_${i}";
761 % $da_ages{$cellid}= $age;
763 (Data age: <span id="<% $cellid %>"><% prettyprint_age($age) %></span>)
764 % } elsif (!defined $total) {
768 % $total += $t->{Total};
769 % my $span= 0 + keys %{ $t->{Stalls} };
770 % my $td= "td rowspan=$span";
771 <tr class="datarow<% $dline %>">
772 <<% $td %>><% $collectdeliver %>
773 <<% $td %>><% $t->{'commodname'} |h %>
775 % my @stalls= sort keys %{ $t->{Stalls} };
777 % my $name= $stalls[$_[0]];
782 <<% $td %> align=right><% $t->{Price} |h %> poe ea.
783 <<% $td %> align=right><% $t->{Qty} |h %> unit(s)
784 <<% $td %> align=right><% $t->{Total} |h %> total
786 % foreach my $stallix (1..$#stalls) {
787 <tr class="datarow<% $dline %>">
788 % $pstall->($stallix);
796 $show_flows->('dst',0,'Deliver'); $show_total->('Proceeds',1);
797 $show_flows->('org',1,'Collect'); $show_total->('(Arbitrage) outlay',-1);
798 $show_flows->('dst',1,'Deliver'); $show_total->('(Arbitrage) proceeds',1);
799 $show_flows->('org',0,'Collect'); $show_total->('Outlay',-1);
801 if ($i < $#islandids) {
802 $totals .= "In hold $total_massvol[$i]{mass} kg,".
803 " $total_massvol[$i]{volume} l";
804 my $delim= '; spare ';
806 my ($max, $got, $units) = @_;
807 return unless defined $max;
809 $totals .= sprintf "%g %s", ($max-$got), $units;
812 $domv->($max_mass, $total_massvol[$i]{mass}, 'kg');
813 $domv->($max_volume, $total_massvol[$i]{volume}, 'l');
816 $show_total_now->($totals);
820 <td colspan=2>Total distance: <% $total_dist %> leagues.
821 <td colspan=3 align=right>Overall net cash flow
822 <td align=right><strong><%
823 $total_total < 0 ? -$total_total." loss" : $total_total." gain"
826 <& query_age:dataages, id2age => \%da_ages &>
828 % } # ========== TRADING PLAN ==========