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.
43 da_pageload= Date.now();
49 my $loss_per_league= 1e-7;
54 my $sd_condition= sub {
56 my $islandid= $islandids[$ix];
57 if (defined $islandid) {
58 return "${bs}.islandid = $islandid";
60 push @query_params, $archipelagoes[$ix];
61 return "${bs}_islands.archipelago = ?";
66 # $islandpair{$a,$b}= [ $start_island_ix, $end_island_ix ]
68 my $specific= !grep { !defined $_ } @islandids;
71 foreach my $src_i (0..$#islandids) {
72 my $src_isle= $islandids[$src_i];
73 my $src_cond= $sd_condition->('sell',$src_i);
75 foreach my $dst_i ($src_i..$#islandids) {
76 my $dst_isle= $islandids[$dst_i];
77 my $dst_cond= $sd_condition->('buy',$dst_i);
78 if ($dst_i==$src_i and !defined $src_isle) {
79 # we always want arbitrage, but mentioning an arch
80 # once shouldn't produce intra-arch trades
82 "($dst_cond AND sell.islandid = buy.islandid)";
84 push @dst_conds, $dst_cond;
86 if ($specific && !$confusing &&
87 # With a circular route, do not carry goods round the loop
88 !($src_i==0 && $dst_i==$#islandids &&
89 $src_isle == $islandids[$dst_i])) {
90 if ($islandpair{$src_isle,$dst_isle}) {
93 $islandpair{$src_isle,$dst_isle}=
98 push @flow_conds, "$src_cond AND (
105 SELECT sell_islands.islandname org_name,
106 sell_islands.islandid org_id,
107 sell.price org_price,
108 sell.qty org_qty_stall,
109 sell_stalls.stallname org_stallname,
110 sell.stallid org_stallid,
111 sell_uploads.timestamp org_timestamp,
112 buy_islands.islandname dst_name,
113 buy_islands.islandid dst_id,
115 buy.qty dst_qty_stall,
116 buy_stalls.stallname dst_stallname,
117 buy.stallid dst_stallid,
118 buy_uploads.timestamp dst_timestamp,
119 ".($qa->{ShowStalls} ? "
120 sell.qty org_qty_agg,
123 (SELECT sum(qty) FROM sell AS sell_agg
124 WHERE sell_agg.commodid = commods.commodid
125 AND sell_agg.islandid = sell.islandid
126 AND sell_agg.price = sell.price) org_qty_agg,
127 (SELECT sum(qty) FROM buy AS buy_agg
128 WHERE buy_agg.commodid = commods.commodid
129 AND buy_agg.islandid = buy.islandid
130 AND buy_agg.price = buy.price) dst_qty_agg,
132 commods.commodname commodname,
133 commods.commodid commodid,
134 commods.unitmass unitmass,
135 commods.unitvolume unitvolume,
137 buy.price - sell.price unitprofit
139 JOIN sell ON commods.commodid = sell.commodid
140 JOIN buy ON commods.commodid = buy.commodid
141 JOIN islands AS sell_islands ON sell.islandid = sell_islands.islandid
142 JOIN islands AS buy_islands ON buy.islandid = buy_islands.islandid
143 JOIN uploads AS sell_uploads ON sell.islandid = sell_uploads.islandid
144 JOIN uploads AS buy_uploads ON buy.islandid = buy_uploads.islandid
145 JOIN stalls AS sell_stalls ON sell.stallid = sell_stalls.stallid
146 JOIN stalls AS buy_stalls ON buy.stallid = buy_stalls.stallid
147 JOIN dists ON aiid = sell.islandid AND biid = buy.islandid
152 AND buy.price > sell.price
153 ORDER BY org_name, dst_name, commodname, unitprofit DESC,
154 org_price, dst_price DESC,
155 org_stallname, dst_stallname
158 my $sth= $dbh->prepare($stmt);
159 $sth->execute(@query_params);
162 my @cols= ({ NoSort => 1 });
166 foreach my $name (@_) {
167 my $col= { Name => $name, %$base };
168 $col->{Numeric}=1 if !$col->{Text};
173 if ($qa->{ShowStalls}) {
174 $addcols->({ Text => 1 }, qw(
175 org_name org_stallname
176 dst_name dst_stallname
179 $addcols->({Text => 1 }, qw(
183 $addcols->({ Text => 1 }, qw(commodname));
184 $addcols->({ DoReverse => 1 },
185 qw( org_price org_qty_agg dst_price dst_qty_agg
187 $addcols->({ DoReverse => 1, SortColKey => 'MarginSortKey' },
190 $addcols->({ DoReverse => 1 },
191 qw( unitprofit MaxQty
197 % if ($qa->{'debug'}) {
200 <% join(' | ',@query_params) |h %>
204 <& dumptable:start, qa => $qa, sth => $sth &>
207 % while ($got= $sth->fetchrow_hashref()) {
210 my $f= $flows[$#flows];
213 grep { $f->{$_} ne $got->{$_} }
214 qw(org_id org_price dst_id dst_price commodid)
216 # Make a new flow rather than adding to the existing one
219 Ix => scalar(@flows),
223 $f->{"org_stallid"}= $f->{"dst_stallid"}= 'all'
224 if !$qa->{ShowStalls};
227 foreach my $od (qw(org dst)) {
229 $got->{"${od}_stallname"}
231 $got->{"${od}_qty_stall"}
236 <& dumptable:row, qa => $qa, sth => $sth, row => $f &>
238 <& dumptable:end, qa => $qa &>
244 print 'No profitable trading opportunities were found.';
248 foreach my $f (@flows) {
250 $f->{MaxQty}= $f->{'org_qty_agg'} < $f->{'dst_qty_agg'}
251 ? $f->{'org_qty_agg'} : $f->{'dst_qty_agg'};
252 $f->{MaxProfit}= $f->{MaxQty} * $f->{'unitprofit'};
253 $f->{MaxCapital}= $f->{MaxQty} * $f->{'org_price'};
255 $f->{MarginSortKey}= sprintf "%d",
256 $f->{'dst_price'} * 10000 / $f->{'org_price'};
257 $f->{Margin}= sprintf "%3.1f%%",
258 $f->{'dst_price'} * 100.0 / $f->{'org_price'} - 100.0;
260 $f->{ExpectedUnitProfit}=
261 $f->{'dst_price'} * (1.0 - $loss_per_league) ** $f->{'dist'}
264 my @uid= $f->{commodid};
265 foreach my $od (qw(org dst)) {
270 $f->{"${od}_stallid"}
271 if $qa->{ShowStalls};
273 $f->{UidLong}= join '_', @uid;
281 my $this= $uue % $base;
282 print STDERR "uue=$uue this=$this ";
287 $cmpu .= chr($this + ($this < 26 ? ord('a') :
288 $this < 52 ? ord('A')-26
290 print STDERR " uue=$uue this=$this cmpu=$cmpu\n";
291 die "$cmpu $uue ?" if length $cmpu > 20;
295 $f->{UidShort}= $cmpu;
297 if ($qa->{'debug'}) {
302 my $v= m/^[a-z]/ ? ord($&)-ord('a') :
303 m/^[A-Z]/ ? ord($&)-ord('A')+26 :
304 m/^[0-9]/ ? ord($&)-ord('0')+52 :
310 #print STDERR "(next)\n";
312 die "$f->{UidShort} $_ ?" unless defined $mul;
313 $outuid[$#outuid] += $v * $mul;
315 #print STDERR "$f->{UidShort} $_ $& v=$v mul=$mul ord()=".ord($&).
316 # "[vs.".ord('a').",".ord('A').",".ord('0')."]".
317 # " outuid=@outuid\n";
322 my $recons_long= join '_', @outuid;
323 $f->{UidLong} eq $recons_long or
324 die "$f->{UidLong} = $f->{UidShort} = $recons_long ?";
327 if (defined $qa->{"R$f->{UidShort}"} &&
328 !defined $qa->{"T$f->{UidShort}"}) {
335 % my $optimise= $specific && !$confusing && @islandids>1;
339 % if (@islandids<=1) {
343 Route contains archipelago(es), not just specific islands.
346 Route is complex - it visits the same island several times
347 and isn't a simple loop.
349 Therefore, optimal trade pattern not calculated.
351 % } else { # ========== OPTMISATION ==========
360 sprintf "%.20f %s", $_->{ExpectedUnitProfit}, $_->{Var}
367 foreach my $flow (@flows) {
368 if ($flow->{Suppress}) {
374 foreach my $od (qw(org dst)) {
375 my $cstname= join '_', (
380 $flow->{"${od}_price"},
381 $flow->{"${od}_stallid"},
384 push @{ $avail_csts{$cstname}{Flows} }, $flow->{Var};
385 $avail_csts{$cstname}{Qty}= $flow->{"${od}_qty_agg"};
388 foreach my $cstname (sort keys %avail_csts) {
389 my $c= $avail_csts{$cstname};
391 ". sprintf("%-30s","$cstname:")." ".
392 join("+", @{ $c->{Flows} }).
393 " <= ".$c->{Qty}."\n";
399 ", map { "$_->{Var} >= 0" } @flows)."
404 if ($qa->{'debug'}) {
413 my $input= pipethrough_prep();
414 print $input $cplex or die $!;
415 my $output= pipethrough_run_along($input, undef, 'glpsol',
416 qw(glpsol --cpxlp /dev/stdin -o /dev/stdout));
417 print "<pre>\n" if $qa->{'debug'};
418 my $found_section= 0;
422 print encode_entities($_) if $qa->{'debug'};
423 if (m/^\s*No\.\s+Column name\s+St\s+Activity\s/) {
424 die if $found_section>0;
428 next unless $found_section==1;
435 m/^\s*\d+\s+f(\d+)\s+\S+\s+(\d+)\s/ or die "$_ ?";
436 my $flow= $flows[$ix] or die;
437 $flow->{OptQty}= $qty;
438 $flow->{OptProfit}= $flow->{'unitprofit'} * $qty;
439 $flow->{OptCapital}= $flow->{OptQty} * $flow->{'org_price'};
441 print "</pre>\n" if $qa->{'debug'};
442 my $prerr= "\n=====\n$cplex\n=====\n$glpsol_out\n=====\n ";
443 pipethrough_run_finish($output,$prerr);
444 die $prerr unless $found_section;
447 $addcols->({ DoReverse => 1 }, qw(
450 $addcols->({ Total => 0, DoReverse => 1 }, qw(
456 % } # ========== OPTIMISATION ==========
460 % my $cdspan= $qa->{ShowStalls} ? ' colspan=2' : '';
461 % my $cdstall= $qa->{ShowStalls} ? '<th>Stall</th>' : '';
462 <table id="trades" rules=groups>
465 <% $qa->{ShowStalls} ? '<colgroup span=2>' : '' %>
476 <th<% $cdspan %>>Collect
477 <th<% $cdspan %>>Deliver
479 <th colspan=2>Collect
480 <th colspan=2>Deliver
484 <th colspan=3>Planned
489 <th>Island <% $cdstall %>
490 <th>Island <% $cdstall %>
508 <tr id="trades_sort">
509 % foreach my $col (@cols) {
513 % foreach my $flowix (0..$#flows) {
514 % my $flow= $flows[$flowix];
515 % my $rowid= "id_row_$flow->{UidShort}";
516 <tr id="<% $rowid %>" class="datarow<% $flowix & 1 %>">
517 <td><input type=hidden name=R<% $flow->{UidShort} %> value="">
518 <input type=checkbox name=T<% $flow->{UidShort} %> value=""
519 <% $flow->{Suppress} ? '' : 'checked' %> >
520 % foreach my $ci (1..$#cols) {
521 % my $col= $cols[$ci];
522 % my $v= $flow->{$col->{Name}};
523 % $col->{Total} += $v if defined $col->{Total};
524 % $v='' if !$col->{Text} && !$v;
525 % my $sortkey= $col->{SortColKey} ?
526 % $flow->{$col->{SortColKey}} : $v;
527 % $ts_sortkeys{$ci}{$rowid}= $sortkey;
528 <td <% $col->{Text} ? '' : 'align=right' %>><% $v |h %>
531 <tr id="trades_total">
534 % foreach my $ci (3..$#cols) {
535 % my $col= $cols[$ci];
537 % if (defined $col->{Total}) {
538 <% $col->{Total} |h %>
543 <& tabsort, cols => \@cols, table => 'trades', rowclass => 'datarow',
544 throw => 'trades_sort', tbrow => 'trades_total' &>
546 ts_sortkeys= <% to_json_protecttags(\%ts_sortkeys) %>;
547 function all_onload() {
550 window.onload= all_onload;
553 <input type=submit name=update value="Update">
555 % if ($optimise) { # ========== TRADING PLAN ==========
557 % my $iquery= $dbh->prepare('SELECT islandname FROM islands
558 % WHERE islandid = ?');
560 % my $total_total= 0;
562 <h1>Voyage trading plan</h1>
564 % foreach my $i (0..$#islandids) {
566 <tr><td colspan=3><strong>
567 % $iquery->execute($islandids[$i]);
568 % my ($islandname) = $iquery->fetchrow_array();
570 Start at <% $islandname |h %>
572 Sail to <% $islandname |h %>
578 foreach my $od (qw(org dst)) {
579 foreach my $f (@flows) {
580 next if $f->{Suppress};
581 next unless $f->{"${od}_id"} == $islandids[$i];
582 next unless $f->{OptQty};
583 my $price= $f->{"${od}_price"};
584 my $stallname= $f->{"${od}_stallname"};
585 my $todo= \$flowlists{$od}{
587 (sprintf "%07d", ($od eq 'dst' ?
588 9999999-$price : $price)),
596 $$todo->{'commodname'}= $f->{'commodname'};
597 $$todo->{'stallname'}= $stallname;
598 $$todo->{Price}= $price;
599 $$todo->{Timestamp}= $f->{"${od}_timestamp"};
600 $$todo->{Qty} += $f->{OptQty};
601 $$todo->{Total}= $$todo->{Price} * $$todo->{Qty};
602 $$todo->{Stalls}= $f->{"${od}Stalls"};
603 if ($f->{'org_id'} == $f->{'dst_id'}) {
604 $$todo->{"${od}Arbitrage"}= 1;
611 my $show_flows= sub {
612 my ($od,$arbitrage,$collectdeliver) = @_;
615 % my $todo= $flowlists{$od};
616 % return unless $todo;
617 % foreach my $tkey (sort keys %$todo) {
618 % my $t= $todo->{$tkey};
619 % next if $t->{"${od}Arbitrage"} != $arbitrage;
620 % if (!$age_reported++) {
621 % my $age= $now - $t->{Timestamp};
622 % my $cellid= "da_${i}";
623 % $da_ages{$cellid}= $age;
625 (Data age: <span id="<% $cellid %>"><% prettyprint_age($age) %></span>)
626 % } elsif (!defined $total) {
630 % $total += $t->{Total};
631 % my $span= 0 + keys %{ $t->{Stalls} };
632 % my $td= "td rowspan=$span";
633 <tr class="datarow<% $dline %>">
634 <<% $td %>><% $collectdeliver %>
635 <<% $td %>><% $t->{'commodname'} |h %>
637 % my @stalls= sort keys %{ $t->{Stalls} };
639 % my $name= $stalls[$_[0]];
644 <<% $td %> align=right><% $t->{Price} |h %> poe ea.
645 <<% $td %> align=right><% $t->{Qty} |h %> unit(s)
646 <<% $td %> align=right><% $t->{Total} |h %> total
648 % foreach my $stallix (1..$#stalls) {
649 <tr class="datarow<% $dline %>">
650 % $pstall->($stallix);
656 % my $show_total= sub {
657 % my ($totaldesc, $sign)= @_;
658 % if (defined $total) {
661 <td colspan=2 align=right><% $totaldesc %>
662 <td align=right><% $total |h %> total
663 % $total_total += $sign * $total;
670 $show_flows->('dst',0,'Deliver'); $show_total->('Proceeds',1);
671 $show_flows->('org',1,'Collect'); $show_total->('(Arbitrage) outlay',-1);
672 $show_flows->('dst',1,'Deliver'); $show_total->('(Arbitrage) proceeds',1);
673 $show_flows->('org',0,'Collect'); $show_total->('Outlay',-1);
679 <td colspan=3 align=right>Overall net cash flow
680 <td align=right><strong><%
681 $total_total < 0 ? -$total_total." loss" : $total_total." gain"
684 <& query_age:dataages, id2age => \%da_ages &>
686 % } # ========== TRADING PLAN ==========