chiark / gitweb /
replace commented-out debugging printlns with ones which use dtxt
[jarrg-ian.git] / src / com / tedpearson / ypp / market / MarketUploader.java
1 package com.tedpearson.ypp.market;
2
3 import java.awt.*;
4 import java.awt.event.*;
5
6 import javax.accessibility.*;
7 import javax.swing.*;
8
9 import com.sun.java.accessibility.util.*;
10
11 import java.util.*;
12 import java.io.*;
13 import java.util.*;
14 import java.net.URL;
15 import org.w3c.dom.*;
16 import javax.xml.parsers.DocumentBuilderFactory;
17 import org.xml.sax.InputSource;
18 import java.util.zip.GZIPOutputStream;
19 import net.chiark.yarrg.ClientHttpRequest;
20 import java.util.regex.*;
21 import java.util.prefs.Preferences;
22 import java.beans.*;
23
24 /**
25 *       MarketUploader is a class that handles the uploading of market
26 *       data from Yohoho! Puzzle Pirates via the Java Accessibility
27 *       API.
28 *
29 *       MarketUploader initializes after the main YPP window has
30 *       initialized. It provides a simple window with a "Capture
31 *       Market Data" button displayed.  Upon clicking this button, a
32 *       progress dialog is displayed, and the data is processed and
33 *       submitted to the YARRG and PCTB servers. If any errors occur,
34 *       an error dialog is shown, and processing returns, the button
35 *       becoming re-enabled.
36 */
37 public class MarketUploader implements TopLevelWindowListener, GUIInitializedListener {
38         private JFrame frame = null;
39         private Window window = null;
40         private JButton findMarket = null;
41         private JLabel resultSummary = null;
42         private JLabel arbitrageResult = null;
43         private long startTime = 0;
44
45         private final static String PCTB_LIVE_HOST_URL = "http://pctb.crabdance.com/";
46         private final static String PCTB_TEST_HOST_URL = "http://pctb.ilk.org/";
47         private String PCTB_HOST_URL;
48
49         // Yarrg protocol parameters
50         private final static String YARRG_CLIENTNAME = "jpctb greenend";
51         private final static String YARRG_CLIENTVERSION =
52             com.tedpearson.ypp.market.Version.version;
53         private final static String YARRG_CLIENTFIXES = "bug-094";
54         private final static String YARRG_LIVE_URL = "http://upload.yarrg.chiark.net/commod-update-receiver";
55         private final static String YARRG_TEST_URL = "http://upload.yarrg.chiark.net/test/commod-update-receiver";
56         private String YARRG_URL;
57
58         private boolean uploadToYarrg;
59         private boolean uploadToPCTB;
60         private boolean showArbitrage;
61
62         private String islandName = null;
63         private String oceanName = null;
64         private java.util.concurrent.CountDownLatch latch = null;
65
66         private AccessibleContext sidePanel;
67         private HashMap<String,Integer> commodMap;
68         public PrintStream dtxt = null;
69
70         private PropertyChangeListener changeListener = new PropertyChangeListener() {
71                 public void propertyChange(PropertyChangeEvent e) {
72                         if(e.getNewValue() != null && 
73                                         e.getPropertyName().equals(AccessibleContext.ACCESSIBLE_CHILD_PROPERTY)) {
74                                 Accessible islandInfo = descendNodes(window,new int[] {0,1,0,0,2,2,0,0,0,0,1,2});;
75                                 String text = islandInfo.getAccessibleContext().getAccessibleText().getAtIndex(AccessibleText.SENTENCE,0);
76                                 int index = text.indexOf(":");
77                                 String name = text.substring(0,index);
78                                 islandName = name;
79                                 // if (dtxt!=null) dtxt.println(islandName);
80                                 sidePanel.removePropertyChangeListener(this);
81                                 latch.countDown();
82                         }
83                 }
84             };
85
86         private int parseQty(String str) {
87                 if (str.equals(">1000")) {
88                         return 1001;
89                 } else {
90                         return Integer.parseInt(str);
91                 }
92         }
93
94         private void progresslog(String s) {
95             if (dtxt == null) return;
96             long now = new Date().getTime();
97             dtxt.println("progress "+(now - startTime)+"ms "+s);
98         }
99
100         private void progressNote(ProgressMonitor pm, String s) {
101             String arb = null;
102             if (arbitrageResult != null)
103                 arb = arbitrageResult.getText();
104             if (arb != null && arb.length() != 0)
105                 s = "<html>" + arb + "<br>" + s;
106             pm.setNote(s);
107         }
108         
109         /**
110         *       An abstract market offer, entailing a commodity being bought or sold by
111         *       a shoppe, for a certain price in a certain quantity. Not instantiable.
112         *
113         *       @see Buy
114         *       @see Sell
115         */
116         abstract class Offer {
117                 public int commodity, price, quantity, shoppe;
118                 /**
119                 *       Create an offer from <code>record</code>, determining the shoppe Id from
120                 *       <code>stallMap</code> and the commodity Id from <code>commodMap</code>.
121                 *       <code>priceIndex</code> should be the index of the price in the record
122                 *       (the quantity will be <code>priceIndex + 1</code>).
123                 *
124                 *       @param record the record with data to create the offer from
125                 *       @param stallMap a map containing the ids of the various stalls
126                 *       @param commodMap a map containing the ids of the various commodities
127                 *       @param priceIndex the index of the price in the record
128                 */
129                 public Offer(ArrayList<String> record, LinkedHashMap<String,Integer> stallMap, HashMap<String,Integer> commodMap,
130                                 int priceIndex) {
131                         Integer commodId = commodMap.get(record.get(0));
132                         if(commodId == null) {
133                                 throw new IllegalArgumentException();
134                         }
135                         commodity = commodId.intValue();
136                         price = Integer.parseInt(record.get(priceIndex));
137                         String qty = record.get(priceIndex+1);
138                         quantity = parseQty(qty);
139                         shoppe = stallMap.get(record.get(1)).intValue();
140                 }
141                 
142                 /**
143                 *       Returns a human-readable version of this offer, useful for debugging
144                 *       
145                 *       @return human-readable offer
146                 */
147                 public String toString() {
148                         return "[C:" + commodity + ",$" + price + ",Q:" + quantity + ",S:" + shoppe + "]";
149                 }
150         }
151         
152         /**
153         *       An offer from a shoppe or stall to buy a certain quantity of a commodity
154         *       for a certain price. If placed in an ordered Set, sorts by commodity index ascending,
155         *       then by buy price descending, and finally by stall id ascending.
156         */
157         class Buy extends Offer implements Comparable<Buy> {
158                 /**
159                 *       Creates a new <code>Buy</code> offer from the given <code>record</code>
160                 *       using the other parameters to determine stall id and commodity id of the offer.
161                 *
162                 *       @param record the record with data to create the offer from
163                 *       @param stallMap a map containing the ids of the various stalls
164                 *       @param commodMap a map containing the ids of the various commodities
165                 */
166                 public Buy(ArrayList<String> record, LinkedHashMap<String,Integer> stallMap, HashMap<String,Integer> commodMap) {
167                         super(record,stallMap,commodMap,2);
168                 }
169                 
170                 /**
171                 *       Sorts by commodity index ascending, then price descending, then stall id ascending.
172                 */
173                 public int compareTo(Buy buy) {
174                         // organize by: commodity index, price, stall index
175                         if(commodity == buy.commodity) {
176                                 // organize by price, then by stall index
177                                 if(price == buy.price) {
178                                         // organize by stall index
179                                         return shoppe>buy.shoppe ? 1 : -1;
180                                 } else if(price > buy.price) {
181                                         return -1;
182                                 } else {
183                                         return 1;
184                                 }
185                         } else if(commodity > buy.commodity) {
186                                 return 1;
187                         } else {
188                                 return -1;
189                         }
190                 }
191         }
192         
193         /**
194         *       An offer from a shoppe or stall to sell a certain quantity of a commodity
195         *       for a certain price. If placed in an ordered Set, sorts by commodity index ascending,
196         *       then by sell price ascending, and finally by stall id ascending.
197         */
198         class Sell extends Offer implements Comparable<Sell> {
199                 /**
200                 *       Creates a new <code>Sell</code> offer from the given <code>record</code>
201                 *       using the other parameters to determine stall id and commodity id of the offer.
202                 *
203                 *       @param record the record with data to create the offer from
204                 *       @param stallMap a map containing the ids of the various stalls
205                 *       @param commodMap a map containing the ids of the various commodities
206                 */
207                 public Sell(ArrayList<String> record, LinkedHashMap<String,Integer> stallMap, HashMap<String,Integer> commodMap) {
208                         super(record,stallMap,commodMap,4);
209                 }
210                 
211                 /**
212                 *       Sorts by commodity index ascending, then price ascending, then stall id ascending.
213                 */
214                 public int compareTo(Sell sell) {
215                         // organize by: commodity index, price, stall index
216                         if(commodity == sell.commodity) {
217                                 // organize by price, then by stall index
218                                 if(price == sell.price) {
219                                         // organize by stall index
220                                         return shoppe>sell.shoppe ? 1 : -1;
221                                 } else if(price > sell.price) {
222                                         return 1;
223                                 } else {
224                                         return -1;
225                                 }
226                         } else if(commodity > sell.commodity) {
227                                 return 1;
228                         } else {
229                                 return -1;
230                         }
231                 }
232         }
233         
234         /**
235         *       Entry point.  Read our preferences.
236         */
237         public MarketUploader() {
238                 // check if we've been turned off in the control panel
239                 Preferences prefs = Preferences.userNodeForPackage(getClass());
240
241                 if (prefs.getBoolean("writeDebugFiles", false)) {
242                     try {
243                         dtxt = new PrintStream(new File("jarrg-debug-log.txt"));
244                     } catch (java.io.FileNotFoundException e) {
245                         System.err.println("JARRG: Error opening debug log: "+e);
246                     }
247                 }
248
249                 if (prefs.getBoolean("useLiveServers", false)) {
250                         YARRG_URL = YARRG_LIVE_URL;
251                         PCTB_HOST_URL = PCTB_LIVE_HOST_URL;
252                 } else {
253                         YARRG_URL = YARRG_TEST_URL;
254                         PCTB_HOST_URL = PCTB_TEST_HOST_URL;
255                 }
256                 
257                 uploadToYarrg=prefs.getBoolean("uploadToYarrg", true);
258                 uploadToPCTB=prefs.getBoolean("uploadToPCTB", true);
259                 showArbitrage=prefs.getBoolean("showArbitrage", true);
260
261                 EventQueueMonitor.addTopLevelWindowListener(this);
262                 if (EventQueueMonitor.isGUIInitialized()) {
263                         createGUI();
264                 } else {
265                         EventQueueMonitor.addGUIInitializedListener(this);
266                 }
267         }
268         
269         /**
270         *       Set up the GUI, with its window and one-button
271         *       interface. Only initialize if we're running alongside
272         *       a Window named "Puzzle Pirates" though.
273         */
274         private void createGUI() {
275                 if (frame != null && window != null) {
276                         if (window.getAccessibleContext().getAccessibleName().equals("Puzzle Pirates")) frame.setVisible(true);
277                         return;
278                 }
279                 frame = new JFrame("Jarrg Uploader");
280                 frame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);
281                 GridLayout layout = new GridLayout(2,1);
282                 frame.getContentPane().setLayout(layout);
283                 //frame.setPreferredSize(new Dimension(200, 60));
284                 
285                 findMarket = new JButton("Upload Market Data");
286                 findMarket.addActionListener(new ActionListener() {
287                         public void actionPerformed(ActionEvent e) {
288                                 findMarket.setEnabled(false);
289                                 new Thread() {
290                                         public void run() {
291                                                 startTime = new Date().getTime();
292                                                 resultSummary.setText("");
293                                                 arbitrageResult.setText("");
294                                                 try {
295                                                         runUpload();
296                                                 } catch(Exception e) {
297                                                         error(e.toString());
298                                                         e.printStackTrace();
299                                                         resultSummary.setText("failed");
300                                                 } finally {
301                                                         if(sidePanel != null) {
302                                                                 // remove it if it's still attached
303                                                                 sidePanel.removePropertyChangeListener(changeListener);
304                                                         }
305                                                 }
306                                                 //findMarketTable();
307                                                 findMarket.setEnabled(true);
308                                         }
309                                 }.start();
310                         }
311                 });
312                 frame.add(findMarket);
313
314                 resultSummary = new JLabel("ready");
315                 frame.add(resultSummary);
316                 
317                 arbitrageResult = new JLabel("");
318
319                 if (showArbitrage) {
320                     layout.setRows(layout.getRows() + 1);
321                     frame.add(arbitrageResult);
322                 }
323
324                 frame.pack();
325         }
326         
327         /**
328         *       Finds the island name from the /who tab, sets global islandName variable
329         */
330         private void getIsland() {
331
332                 // If the league tracker is there, we can skip the faff
333                 // and ask for its tooltip, since we're on a boat
334
335                 Accessible leagueTracker = descendNodes(window,new int[] {0,1,0,0,2,1,1,1});
336                 try {
337                         islandName = ((JLabel)leagueTracker).getToolTipText();
338                 } catch (NullPointerException e) {
339                         // evidently we're actually on an island
340
341                         islandName = null;
342                         AccessibleContext chatArea = descendNodes(window,new int[] {0,1,0,0,0,2,0,0,2}).getAccessibleContext();
343                         // attach the property change listener to the outer sunshine panel if the "ahoy" tab
344                         // is not active, otherwise attach it to the scroll panel in the "ahoy" tab.
345                         if(!"com.threerings.piracy.client.AttentionListPanel".
346                            equals(descendNodes(window,new int[] {0,1,0,0,2,2,0}).getClass().getCanonicalName())) {
347                                 sidePanel = descendNodes(window,new int[] {0,1,0,0,2,2}).getAccessibleContext();
348                         } else {
349                                 sidePanel = descendNodes(window,new int[] {0,1,0,0,2,2,0,0,0}).getAccessibleContext();
350                         }
351                         sidePanel.addPropertyChangeListener(changeListener);
352                         latch = new java.util.concurrent.CountDownLatch(1);
353                         // make the Players Online ("/who") panel appear
354                         AccessibleEditableText chat = chatArea.getAccessibleEditableText();
355                         chat.setTextContents("/w");
356                         int c = chatArea.getAccessibleAction().getAccessibleActionCount();
357                         for(int i=0;i<c;i++) {
358                                 if("notify-field-accept".equals(chatArea.getAccessibleAction().getAccessibleActionDescription(i))) {
359                                         chatArea.getAccessibleAction().doAccessibleAction(i);
360                                 }
361                         }
362                 }
363                 // if we don't find the island name, hopefully the server will
364         }
365
366         /**
367          *      Find the ocean name from the window title, and set global oceanName variable
368          */
369         private void getOcean() {
370                 oceanName = null;
371                 AccessibleContext topwindow = window.getAccessibleContext();
372                 oceanName = topwindow.getAccessibleName().replaceAll(".*on the (\\w+) ocean", "$1");
373         }
374
375
376         /**
377         *       Shows a dialog with the error <code>msg</code>.
378         *
379         *       @param msg a String describing the error that occured.
380         */
381         private void error(String msg) {
382                 JOptionPane.showMessageDialog(frame,msg,"Error",JOptionPane.ERROR_MESSAGE);
383         }
384         
385         private void error_html(String msg, String html) {
386                 //System.err.println("===" + html + "===");
387
388                 Pattern body = Pattern.compile("<body>(.*)</body>", Pattern.DOTALL | Pattern.CASE_INSENSITIVE);
389                 Matcher m = body.matcher(html);
390                 if (m.find()) {
391                         html = m.group(1);
392                         Pattern fixup = Pattern.compile("<(\\w+) */>");;
393                         m = fixup.matcher(html);
394                         html = m.replaceAll("<$1>");
395                         m = Pattern.compile("[\\r\\n]+").matcher(html);
396                         html = m.replaceAll(" ");
397                 }
398                 String whole_msg = "<html><h1>Error</h1>"+msg+"<h1>PCTB Server said:</h1><blockquote>"+html+"</blockquote>";
399                 if (dtxt!=null) dtxt.println("###" + whole_msg + "###");
400
401                 JOptionPane.showMessageDialog(frame,whole_msg,"Error",JOptionPane.ERROR_MESSAGE);
402         }
403         
404         /**
405         *       Run the data collection process, and upload the results. This is the method
406         *       that calls most of the other worker methods for the process. If an error occurs,
407         *       the method will call the error method and return early, freeing up the button
408         *       to be clicked again.
409         *
410         *       @exception Exception if an error we didn't expect occured
411         */
412         private void runUpload() throws Exception {
413                 progresslog("starting");
414
415                 String yarrgts = "";
416                 ProgressMonitor pm = new ProgressMonitor(frame,"Processing Market Data","Getting table data",0,100);
417                 pm.setMillisToDecideToPopup(0);
418                 pm.setMillisToPopup(0);
419                 boolean doneyarrg = false, donepctb = false;
420
421                 if (uploadToYarrg) {
422                         progresslog("yarrg timestamp...");
423                         yarrgts = getYarrgTimestamp();
424                         progresslog("yarrg timestamp done.");
425                 }
426
427                 AccessibleTable accesstable = findMarketTable();
428                 if(accesstable == null) {
429                         error("Market table not found! Please open the Buy/Sell Commodities interface.");
430                         return;
431                 }
432                 if(accesstable.getAccessibleRowCount() == 0) {
433                         error("No data found, please wait for the table to have data first!");
434                         return;
435                 }
436                 if(!isDisplayAll()) {
437                         error("Please select \"All\" from the Display: popup menu.");
438                         return;
439                 }
440
441                 progresslog("getisland...");
442                 getIsland();
443                 progresslog("getocean...");
444                 getOcean();
445                 progresslog("getocean done");
446
447                 if (latch != null) {
448                     latch.await(2, java.util.concurrent.TimeUnit.SECONDS);
449                 }
450
451                 if (islandName == null) {
452                     error("Could not find island name in YPP user interface.");
453                     return;
454                 }
455
456                 progresslog("table check...");
457
458                 String headings_expected[] = new String[]
459                     { "Commodity", "Trading outlet", "Buy price", "Will buy", "Sell price", "Will sell" };
460                 ArrayList<ArrayList<String>> headers = getData(accesstable.getAccessibleColumnHeader());
461                 if (headers.size() != 1) {
462                     error("Table headings not one row! " + headers.toString());
463                     return;
464                 }
465                 if (headers.get(0).size() != 6) {
466                     error("Table headings not six columns! " + headers.toString());
467                     return;
468                 }
469                 for (int col=0; col<headings_expected.length; col++) {
470                     String expd = headings_expected[col];
471                     String got = headers.get(0).get(col);
472                     if (expd.compareTo(got) != 0) {
473                         error("Table heading for column "+col
474                               +" is not \""+expd+"\" but \""+got+"\".\n\n"
475                               +"Please do not reorder the table when using this tool.");
476                         return;
477                     }
478                 }
479
480                 progresslog("table read...");
481
482                 ArrayList<ArrayList<String>> data = getData(accesstable);
483
484                 if (showArbitrage) {
485                         progresslog("arbitrage...");
486                         calculateArbitrage(data);
487                         progresslog("arbitrage done.");
488                 }
489
490                 if (uploadToYarrg && yarrgts != null) {
491                         progresslog("yarrg prepare...");
492                         progressNote(pm, "Yarrg: Preparing data");
493                         pm.setProgress(10);
494
495                         StringBuilder yarrgsb = new StringBuilder();
496                         String yarrgdata; // string containing what we'll feed to yarrg
497                 
498                         for (ArrayList<String> row : data) {
499                                 if (row.size() > 6) {
500                                         row.remove(6);
501                                 }
502                                 for (String rowitem : row) {
503                                         yarrgsb.append(rowitem != null ? rowitem : "");
504                                         yarrgsb.append("\t");
505                                 }
506                                 yarrgsb.setLength(yarrgsb.length()-1); // chop
507                                 yarrgsb.append("\n");
508                         }
509
510                         yarrgdata = yarrgsb.toString();
511
512                         progressNote(pm, "Yarrg: Uploading");
513                         progresslog("yarrg upload...");
514
515                         doneyarrg = runYarrg(yarrgts, oceanName, islandName, yarrgdata);
516                         progresslog("yarrg done.");
517                 }
518
519                 if (uploadToPCTB) {
520                     progresslog("pctb prepare...");
521                     progressNote(pm, "PCTB: Getting stall names");
522                     pm.setProgress(20);
523                     if(pm.isCanceled()) {
524                         return;
525                     }
526                     TreeSet<Offer> buys = new TreeSet<Offer>();
527                     TreeSet<Offer> sells = new TreeSet<Offer>();
528                     LinkedHashMap<String,Integer> stallMap = getStallMap(data);
529                     pm.setProgress(40);
530                     progressNote(pm, "PCTB: Sorting offers");
531                     if(pm.isCanceled()) {
532                         return;
533                     }
534                     // get commod map
535                 
536                     HashMap<String,Integer> commodMap = getCommodMap();
537                     if(commodMap == null) {
538                         return;
539                     }
540                     int[] offerCount = getBuySellMaps(data,buys,sells,stallMap,commodMap);
541                     //println(buys.toString());
542                     // if (dtxt!=null) dtxt.println(sells);
543                     // if (dtxt!=null) dtxt.println("\n\n\n"+buys);
544
545                     ByteArrayOutputStream outStream = new ByteArrayOutputStream();
546                     pm.setProgress(60);
547                     progressNote(pm, "PCTB: Sending data");
548                     if(pm.isCanceled()) {
549                         return;
550                     }
551                     GZIPOutputStream out = new GZIPOutputStream(outStream);
552                     //FileOutputStream out = new FileOutputStream(new File("output.text"));
553                     DataOutputStream dos = new DataOutputStream(out);
554                     dos.writeBytes("005y\n");
555                     dos.writeBytes(stallMap.size()+"\n");
556                     dos.writeBytes(getAbbrevStallList(stallMap));
557                     writeBuySellOffers(buys,sells,offerCount,out);
558                     out.finish();
559                     progresslog("pctb send...");
560                     InputStream in = sendInitialData(new ByteArrayInputStream(outStream.toByteArray()));
561                     progresslog("pctb sent.");
562                     if (in == null) return;
563                     pm.setProgress(80);
564                     if(pm.isCanceled()) {
565                         return;
566                     }
567                     progressNote(pm, "PCTB: Waiting ...");
568                     progresslog("pctb finish...");
569                     donepctb = finishUpload(in);
570                     progresslog("pctb done.");
571                 }
572                 pm.setProgress(100);
573
574                 if ((uploadToPCTB && !donepctb) ||
575                     (uploadToYarrg && !doneyarrg)) {
576                         resultSummary.setText("trouble");
577                 } else if (donepctb || doneyarrg) {
578                         resultSummary.setText("Done " + islandName);
579                 } else {
580                         resultSummary.setText("uploaded nowhere!");
581                 }
582                 progresslog("done.");
583         }
584         
585         /**
586         *       Get the offer data out of the table and cache it in an <code>ArrayList</code>.
587         *       
588         *       @param table the <code>AccessibleTable</code> containing the market data
589         *       @return an array of record arrays, each representing a row of the table
590         */
591         private ArrayList<ArrayList<String>> getData(AccessibleTable table) {
592                 ArrayList<ArrayList<String>> data = new ArrayList<ArrayList<String>>();
593                 for (int i = 0; i < table.getAccessibleRowCount(); i++) {
594                         ArrayList<String> row = new ArrayList<String>();
595                         for (int j = 0; j < table.getAccessibleColumnCount(); j++) {
596                                 row.add(table.getAccessibleAt(i, j).getAccessibleContext().getAccessibleName());
597                         }
598                         data.add(row);
599                 }
600                 return data;
601         }
602         
603         /**
604         *       @return the table containing market data if it exists, otherwise <code>null</code>
605         */
606         public AccessibleTable findMarketTable() {
607                 Accessible node1 = window;
608                 Accessible node = descendNodes(node1,new int[] {0,1,0,0,0,0,1,0,0,1,0,0}); // commod market
609                 // commod market: {0,1,0,0,0,0,1,0,0,1,0}  {0,1,0,0,0,0,1,0,1,0,0,1,0,0})
610                 // if (dtxt!=null) dtxt.println(node);
611                 if (!(node instanceof JTable)) {
612                         node = descendNodes(node1,new int[] {0,1,0,0,0,0,1,0,1,0,0,1,0,0}); // commod market
613                 }
614                 if (!(node instanceof JTable)) return null;
615                 AccessibleTable table = node.getAccessibleContext().getAccessibleTable();
616                 // if (dtxt!=null) dtxt.println(table);
617                 return table;
618         }
619         
620         /**
621         *       Utility method to descend through several levels of Accessible children
622         *       at once.
623         *
624         *       @param parent the node on which to start the descent
625         *       @param path an array of ints, each int being the index of the next
626         *       accessible child to descend.
627         *       @return the <code>Accessible</code> reached by following the descent path,
628         *       or <code>null</code> if the desired path was invalid.
629         */
630         private Accessible descendNodes(Accessible parent, int[] path) {
631                 for(int i=0;i<path.length;i++) {
632                         if (null == (parent = descend(parent, path[i]))) return null;
633                         // if (dtxt!=null) dtxt.println(parent.getClass());
634                 }
635                 return parent;
636         }
637         
638         /**
639         *       Descends one level to the specified child of the parent <code>Accessible</code> "node".
640         *       
641         *       @param parent the node with children
642         *       @param childNum the index of the child of <code>parent</code> to return
643         *       @return the <code>childNum</code> child of <code>parent</code> or <code>null</code>
644         *       if the child is not found.
645         */
646         private Accessible descend(Accessible parent, int childNum) {
647                 if (childNum >= parent.getAccessibleContext().getAccessibleChildrenCount()) return null;
648                 return parent.getAccessibleContext().getAccessibleChild(childNum);
649         }
650         
651         public static void main(String[] args) {
652                 new MarketUploader();
653         }
654
655         /**
656         *       Set the global window variable after the YPP window is created,
657         *       remove the top level window listener, and start the GUI
658         */
659         public void topLevelWindowCreated(Window w) {
660                 window = w;
661                 EventQueueMonitor.removeTopLevelWindowListener(this);
662                 createGUI();
663         }
664         
665         /**
666         *       Returns true if the "Display:" menu on the commodities interface in YPP is set to "All"
667         *
668         *       @return <code>true</code> if all commodities are displayed, otherwise <code>false</code>
669         */
670         private boolean isDisplayAll() {
671                 Accessible button = descendNodes(window,new int[] {0,1,0,0,0,0,1,0,0,0,1});
672                 if(!(button instanceof JButton)) {
673                         button = descendNodes(window,new int[] {0,1,0,0,0,0,1,0,1,0,0,0,1});
674                 }
675                 String display = button.getAccessibleContext().getAccessibleName();
676                 if(!display.equals("All")) {
677                         return false;
678                 }
679                 return true;
680         }
681         
682         public void topLevelWindowDestroyed(Window w) {}
683
684         public void guiInitialized() {
685                 createGUI();
686         }
687         
688         /**
689         *       Gets the list of commodities and their associated commodity ids.
690         *       On the first run, the data is downloaded from the PCTB server. 
691         *       After the first run, the data is cached using <code>Preferences</code>.
692         *       <p>
693         *       Potential issues: When more commodities are added to the server, this
694         *       program will currently break unless the user deletes the preferences
695         *       file or we give them a new release with a slighly different storage
696         *       location for the data.
697         *
698         *       @return a map where the key is the commodity and the value is the commodity id.
699         */
700         private HashMap<String,Integer> getCommodMap() {
701                 if(commodMap != null) {
702                         return commodMap;
703                 }
704                 HashMap<String,Integer> map = new HashMap<String,Integer>();
705                 Preferences prefs = Preferences.userNodeForPackage(getClass());
706                 String xml;
707                 try {
708                         URL host = new URL(PCTB_HOST_URL + "commodmap.php");
709                         BufferedReader br = new BufferedReader(new InputStreamReader(host.openStream()));
710                         StringBuilder sb = new StringBuilder();
711                         String str;
712                         while((str = br.readLine()) != null) {
713                                 sb.append(str);
714                         }
715                         int first = sb.indexOf("<pre>") + 5;
716                         int last = sb.indexOf("</body>");
717                         xml = sb.substring(first,last);
718                         //if (dtxt!=null) {
719                         //        dtxt.println(">>");
720                         //        dtxt.println(sb);;
721                         //        dtxt.println("||");
722                         //        dtxt.println(xml);
723                         //        dtxt.println("<<");
724                         //}
725                         // if (dtxt!=null) dtxt.println(xml);
726                         Reader reader = new CharArrayReader(xml.toCharArray());
727                         Document d = DocumentBuilderFactory.newInstance().newDocumentBuilder().parse(new InputSource(reader));
728                         NodeList maps = d.getElementsByTagName("CommodMap");
729                         for(int i=0;i<maps.getLength();i++) {
730                                 NodeList content = maps.item(i).getChildNodes();
731                                 Integer num = Integer.parseInt(content.item(1).getTextContent());
732                                 map.put(content.item(0).getTextContent(),num);
733                         }
734                 } catch(Exception e) {
735                         e.printStackTrace();
736                         error("Unable to load Commodity list from server!");
737                         return null;
738                 }
739                 commodMap = map;
740                 return map;
741         }
742         
743         /**
744         *       Given the list of offers, this method will find all the unique stall names
745         *       and return them in a <code>LinkedHashMap</code> where the key is the stall name
746         *       and the value is the generated stall id (position in the list).
747         *       <p>
748         *       The reason this method returns a LinkedHashMap instead of a simple HashMap is the need
749         *       for iterating over the stall names in insertion order for output to the server.
750         *
751         *       @param offers the list of records from the commodity buy/sell interface
752         *       @return an iterable ordered map of the stall names and generated stall ids
753         */
754         private LinkedHashMap<String,Integer> getStallMap(ArrayList<ArrayList<String>> offers) {
755                 int count = 0;
756                 LinkedHashMap<String,Integer> map = new LinkedHashMap<String,Integer>();
757                 for(ArrayList<String> offer : offers) {
758                         String shop = offer.get(1);
759                         if(!map.containsKey(shop)) {
760                                 count++;
761                                 map.put(shop,count);
762                         }
763                 }
764                 return map;
765         }
766         
767         /**
768         *       Gets a sorted list of Buys and Sells from the list of records. <code>buys</code> and <code>sells</code>
769         *       should be pre-initialized and passed into the method to receive the data.
770         *       Returns a 2-length int array with the number of buys and sells found.
771         *       
772         *       @param offers the data found from the market table in-game
773         *       @param buys an empty initialized <code>TreeSet&lt;Offer&gt;</code> to
774         *       hold the Buy offers.
775         *       @param sells an empty initialized <code>TreeSet&lt;Offer&gt;</code> to
776         *       hold the Sell offers.
777         *       @param stalls the map of stalls to their ids
778         *       @param commodMap the map of commodities to their ids
779         *       @return a 2-length int[] array containing the number of buys and sells, respectively
780         */
781         private int[] getBuySellMaps(ArrayList<ArrayList<String>> offers, TreeSet<Offer> buys,
782                         TreeSet<Offer> sells, LinkedHashMap<String,Integer> stalls, HashMap<String,Integer> commodMap) {
783                 int[] buySellCount = new int[2];
784                 for(ArrayList<String> offer : offers) {
785                         try {
786                                 if(offer.get(2) != null) {
787                                         buys.add(new Buy(offer,stalls,commodMap));
788                                         buySellCount[0]++;
789                                 }
790                                 if(offer.get(4) != null) {
791                                         sells.add(new Sell(offer,stalls,commodMap));
792                                         buySellCount[1]++;
793                                 }
794                         } catch(IllegalArgumentException e) {
795                                 if (dtxt!=null) dtxt.println("Error: Unsupported Commodity \"" + offer.get(0) + "\"");
796                         }
797                 }
798                 if (buySellCount[0]==0 && buySellCount[1]==0) {
799                     error("No (valid) offers for PCTB?!");
800                     throw new IllegalArgumentException();
801                 }
802                 return buySellCount;
803         }
804         
805         /**
806         *       Prepares the list of stalls for writing to the output stream.
807         *       The <code>String</code> returned by this method is ready to be written
808         *       directly to the stream.
809         *       <p>
810         *       All shoppe names are left as they are. Stall names are abbreviated just before the
811         *       apostrophe in the possessive, with an "^" and a letter matching the stall's type
812         *       appended. Example: "Burninator's Ironworking Stall" would become "Burninator^I".
813         *
814         *       @param stallMap the map of stalls and stall ids in an iterable order
815         *       @return a <code>String</code> containing the list of stalls in format ready
816         *       to be written to the output stream.
817         */
818         private String getAbbrevStallList(LinkedHashMap<String,Integer> stallMap) {
819                 // set up some mapping
820                 HashMap<String,String> types = new HashMap<String,String>();
821                 types.put("Apothecary Stall", "A");
822                 types.put("Distilling Stall", "D");
823                 types.put("Furnishing Stall", "F");
824                 types.put("Ironworking Stall", "I");
825                 types.put("Shipbuilding Stall", "S");
826                 types.put("Tailoring Stall", "T");
827                 types.put("Weaving Stall", "W");
828                 
829                 StringBuilder sb = new StringBuilder();
830                 for(String name : stallMap.keySet()) {
831                         int index = name.indexOf("'s");
832                         String finalName = name;
833                         String type = null;
834                         if (index > 0) {
835                                 finalName = name.substring(0,index);
836                                 if(index + 2 < name.length()) {
837                                         String end = name.substring(index+2,name.length()).trim();
838                                         type = types.get(end);
839                                 }
840                         }
841                         if(type==null) {
842                                 sb.append(name+"\n");
843                         } else {
844                                 sb.append(finalName+"^"+type+"\n");
845                         }
846                 }
847                 return sb.toString();
848         }
849         
850         /**
851         *       Writes a list of offers in correct format to the output stream.
852         *       <p>
853         *       The format is thus: (all numbers are 2-byte integers in little-endian format)
854         *       (number of offers of this type, aka buy/sell)
855         *       (commodity ID) (number of offers for this commodity) [shopID price qty][shopID price qty]... 
856         *
857         *       @param out the output stream to write the data to
858         *       @param offers the offers to write
859         */
860         private void writeOffers(OutputStream out, TreeSet<Offer> offers) throws IOException {
861                 ByteArrayOutputStream buffer = new ByteArrayOutputStream();
862                 if(offers.size() == 0) {
863                         // nothing to write, and "0" has already been written
864                         return;
865                 }
866                 int commodity = offers.first().commodity;
867                 int count = 0;
868                 for(Offer offer : offers) {
869                         if(commodity != offer.commodity) {
870                                 // write out buffer
871                                 writeBufferedOffers(out,buffer.toByteArray(),commodity,count);
872                                 buffer.reset();
873                                 commodity = offer.commodity;
874                                 count = 0;
875                         }
876                         writeLEShort(offer.shoppe,buffer); // stall index
877                         writeLEShort(offer.price,buffer); // buy price
878                         writeLEShort(offer.quantity,buffer); // buy qty
879                         count++;
880                 }
881                 writeBufferedOffers(out,buffer.toByteArray(),commodity,count);
882         }
883         
884         /**
885         *       Writes the buffered data to the output strea for one commodity.
886         *       
887         *       @param out the stream to write to
888         *       @param buffer the buffered data to write
889         *       @param commodity the commmodity id to write before the buffered data
890         *       @param count the number of offers for this commodity to write before the data
891         */
892         private void writeBufferedOffers(OutputStream out, byte[] buffer, int commodity, int count) throws IOException {
893                 writeLEShort(commodity,out); // commod index
894                 writeLEShort(count,out); // offer count
895                 out.write(buffer); // the buffered offers
896         }
897         
898         /**
899         *       Writes the buy and sell offers to the outputstream by calling other methods.
900         *       
901         *       @param buys list of Buy offers to write
902         *       @param sells list of Sell offers to write
903         *       @param offerCount 2-length int array containing the number of buys and sells to write out
904         *       @param out the stream to write to
905         */
906         private void writeBuySellOffers(TreeSet<Offer> buys,
907                         TreeSet<Offer> sells, int[] offerCount, OutputStream out) throws IOException {
908                 // # buy offers
909                 writeLEShort(offerCount[0],out);
910                 writeOffers(out,buys);
911                 // # sell offers
912                 writeLEShort(offerCount[1],out);
913                 writeOffers(out,sells);
914         }
915         
916         private String readstreamstring(InputStream in) throws IOException {
917                 StringBuilder sb = new StringBuilder();
918                 BufferedReader br = new BufferedReader(new InputStreamReader(in));
919                 String str;
920                 while((str = br.readLine()) != null) {
921                         sb.append(str+"\n");
922                 }
923                 return sb.toString();
924         }
925
926         /**
927         *       Sends the data to the server via multipart-formdata POST,
928         *       with the gzipped data as a file upload.
929         *
930         *       @param file an InputStream open to the gzipped data we want to send
931         */
932         private InputStream sendInitialData(InputStream file) throws IOException {
933                 ClientHttpRequest http = new ClientHttpRequest(PCTB_HOST_URL + "upload.php");
934                 http.setParameter("marketdata","marketdata.gz",file,"application/gzip");
935                 if (!http.post()) {
936                         String err = readstreamstring(http.resultstream());
937                         error("Error sending initial data:\n"+err);
938                         return null;
939                 }
940                 return http.resultstream();
941         }
942         
943         /**
944         *       Utility method to write a 2-byte int in little-endian form to an output stream.
945         *
946         *       @param num an integer to write
947         *       @param out stream to write to
948         */
949         private void writeLEShort(int num, OutputStream out) throws IOException {
950                 out.write(num & 0xFF);
951                 out.write((num >>> 8) & 0xFF);
952         }
953         
954         /**
955         *       Reads the response from the server, and selects the correct parameters
956         *       which are sent in a GET request to the server asking it to confirm
957         *       the upload and accept the data into the database. Notably, the island id
958         *       and ocean id are determined, while other parameter such as the filename
959         *       are determined from the hidden form fields.
960         *
961         *       @param in stream of data from the server to read
962         */
963         private boolean finishUpload(InputStream in) throws IOException {
964                 String html = readstreamstring(in);
965                 // if (dtxt!=null) dtxt.println(html);
966                 Matcher m;
967
968                 Pattern params = Pattern.compile("(?s)<input type=\"hidden\" name=\"action\" value=\"setisland\" />.+?<input type=\"hidden\" name=\"forcereload\" value=\"([^\"]+)\" />.+?<input type=\"hidden\" name=\"filename\" value=\"([^\"]+)\" />");
969                 m = params.matcher(html);
970                 if(!m.find()) {
971                         error_html("The PCTB server returned unusual data. Maybe you're using an old version of the uploader?",
972                                    html);
973                         return false;
974                 }
975                 String forceReload = m.group(1);
976                 String filename = m.group(2);
977
978                 Pattern oceanNumPat = Pattern.compile("<option value=\"(\\d+)\">"+oceanName+"</option>");
979                 m = oceanNumPat.matcher(html);
980                 if (!m.find()) {
981                         error_html("Unable to find the ocean in the server's list of oceans!", html);
982                         return false;
983                 }
984                 String oceanNum = m.group(1);
985
986                 Pattern oceanIslandNum = Pattern.compile("islands\\[" + oceanNum + "\\]\\[\\d+\\]=new Option\\(\"" + islandName + "\",(\\d+)");
987                 m = oceanIslandNum.matcher(html);
988                 if(!m.find()) {
989                         error_html("This does not seem to be a valid island! Unable to upload.", html);
990                         return false;
991                 }
992                 String islandNum = m.group(1);
993
994                 URL get = new URL(PCTB_HOST_URL + "upload.php?action=setisland&ocean=" + oceanNum + "&island="
995                         + islandNum + "&forcereload=" + forceReload + "&filename=" + filename);
996                 String complete = readstreamstring(get.openStream());
997                 Pattern done = Pattern.compile("Your data has been integrated into the database. Thank you!");
998                 m = done.matcher(complete);
999                 if(m.find()) {
1000                         if (dtxt!=null) dtxt.println("FILE upload successful!!!");
1001                         return true;
1002                 } else {
1003                         error_html("Something was wrong with the final upload parameters!", complete);
1004                         return false;
1005                 }
1006         }
1007
1008     private InputStream post_for_yarrg(ClientHttpRequest http) throws IOException {
1009         if (!http.post()) {
1010             String err = readstreamstring(http.resultstream());
1011             error("<html><h1>Error reported by YARRG server</h1>\n" + err);
1012             return null;
1013         }
1014         return http.resultstream();
1015     }
1016
1017     private String getYarrgTimestamp() throws IOException {
1018         ClientHttpRequest http = new ClientHttpRequest (YARRG_URL);
1019         http.setParameter("clientname", YARRG_CLIENTNAME);
1020         http.setParameter("clientversion", YARRG_CLIENTVERSION);
1021         http.setParameter("clientfixes", YARRG_CLIENTFIXES);
1022         http.setParameter("requesttimestamp", "y");
1023         InputStream in = post_for_yarrg(http);
1024         if (in == null) return null;
1025         BufferedReader br = new BufferedReader(new InputStreamReader(in));
1026         String tsresult = br.readLine();
1027         return tsresult.substring(3, tsresult.length()-1);
1028     }
1029
1030     private boolean runYarrg(String timestamp, String ocean, String island, String yarrgdata) throws IOException {
1031         ByteArrayOutputStream bos = new ByteArrayOutputStream();
1032         BufferedOutputStream bufos = new BufferedOutputStream(new GZIPOutputStream(bos));
1033         bufos.write(yarrgdata.getBytes() );
1034         bufos.close();
1035         ByteArrayInputStream file = new ByteArrayInputStream(bos.toByteArray());
1036
1037         ClientHttpRequest http = new ClientHttpRequest (YARRG_URL);
1038         http.setParameter("clientname", YARRG_CLIENTNAME);
1039         http.setParameter("clientversion", YARRG_CLIENTVERSION);
1040         http.setParameter("clientfixes", YARRG_CLIENTFIXES);
1041         http.setParameter("timestamp", timestamp);
1042         http.setParameter("ocean", ocean);
1043         http.setParameter("island", island);
1044         http.setParameter("data", "deduped.tsv.gz", file, "application/octet-stream");
1045         InputStream in = post_for_yarrg(http);
1046         if (in == null) return false;
1047         BufferedReader br = new BufferedReader(new InputStreamReader(in));
1048         String yarrgresult; 
1049         while((yarrgresult = br.readLine()) != null) {
1050             if (dtxt!=null) dtxt.println(yarrgresult);
1051         }
1052         return true;
1053     }
1054
1055     private int calculateArbitrageCommodity(ArrayList<SortedSet<int[]>> arb_bs) {
1056         // if (dtxt!=null) dtxt.println("ARBITRAGE?");
1057         int profit = 0;
1058         SortedSet<int[]> buys = arb_bs.get(0);
1059         SortedSet<int[]> sells = arb_bs.get(1);
1060         while (true) {
1061             int[] buy, sell;
1062             try {
1063                 // NB "sell" means they sell, ie we buy
1064                 sell = sells.last();
1065                 buy = buys.first();
1066             } catch (NoSuchElementException e) {
1067                 break;
1068             }
1069
1070             int unitprofit = buy[0] - sell[0];
1071             int count = buy[1] < sell[1] ? buy[1] : sell[1];
1072             // if (dtxt!=null) dtxt.println(" sell @"+sell[0]+" x"+sell[1]+" buy @"+buy[0]+" x"+buy[1]
1073             //                 +" => x"+count+" @"+unitprofit);
1074
1075             if (unitprofit <= 0)
1076                 break;
1077             
1078             profit += count * unitprofit;
1079             buy[1] -= count;
1080             sell[1] -= count;
1081             if (buy[1]==0) buys.remove(buy);
1082             if (sell[1]==0) sells.remove(sell);
1083         }
1084         // if (dtxt!=null) dtxt.println(" PROFIT "+profit);
1085         return profit;
1086     }
1087
1088     private class arbitrageOfferComparator implements Comparator {
1089         public int compare(Object o1, Object o2) {
1090             int p1 = ((int[])o1)[0];
1091             int p2 = ((int[])o2)[0];
1092             return p2 - p1;
1093         }
1094     }
1095
1096     private @SuppressWarnings("unchecked")
1097     void calculateArbitrage(ArrayList<ArrayList<String>> data) {
1098         int arbitrage = 0;
1099         ArrayList<SortedSet<int[]>> arb_bs = null;
1100         String lastcommod = null;
1101         Comparator compar = new arbitrageOfferComparator();
1102
1103         for (ArrayList<String> row : data) {
1104             String thiscommod = row.get(0);
1105             // if (dtxt!=null) dtxt.println("ROW "+row.toString());
1106             if (lastcommod == null || !thiscommod.equals(lastcommod)) {
1107                 if (lastcommod != null)
1108                     arbitrage += calculateArbitrageCommodity(arb_bs);
1109                 // if (dtxt!=null) dtxt.println("ROW rdy");
1110                 arb_bs = new ArrayList<SortedSet<int[]>>(2);
1111                 arb_bs.add(0, new TreeSet<int[]>(compar));
1112                 arb_bs.add(1, new TreeSet<int[]>(compar));
1113                 // if (dtxt!=null) dtxt.println("ROW init");
1114                 lastcommod = thiscommod;
1115             }
1116             for (int bs = 0; bs < 2; bs++) {
1117                 String pricestr = row.get(bs*2 + 2);
1118                 if (pricestr == null)
1119                     continue;
1120                 int[] entry = new int[2];
1121                 // if (dtxt!=null) dtxt.println("ROW BS "+bs);
1122                 entry[0] = parseQty(pricestr);
1123                 entry[1] = parseQty(row.get(bs*2 + 3));
1124                 arb_bs.get(bs).add(entry);
1125             }
1126         }
1127         arbitrage += calculateArbitrageCommodity(arb_bs);
1128         if (arbitrage != 0) {
1129             arbitrageResult.setText("<html><strong>arbitrage: "+arbitrage+" poe</strong>");
1130         } else {
1131             arbitrageResult.setText("no arbitrage");
1132         }
1133     }
1134     
1135 }