1 package net.chiark.yarrg;
4 import java.awt.event.*;
6 import javax.accessibility.*;
9 import com.sun.java.accessibility.util.*;
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;
25 * MarketUploader is a class that handles the uploading of market
26 * data from Yohoho! Puzzle Pirates via the Java Accessibility
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.
37 public class MarketUploader
38 implements Runnable, TopLevelWindowListener, GUIInitializedListener {
39 private JFrame frame = null;
40 private Window window = null;
41 private JButton findMarket = null;
42 private JLabel resultSummary = null;
43 private JLabel arbitrageResult = null;
44 private int unknownPCTBcommods = 0;
45 private long startTime = 0;
46 private ProgressMonitor progmon = null;
48 private final static String PCTB_LIVE_HOST_URL = "http://pctb.crabdance.com/";
49 private final static String PCTB_TEST_HOST_URL = "http://pctb.ilk.org/";
50 private String PCTB_HOST_URL;
52 // Yarrg protocol parameters
53 private final static String YARRG_CLIENTNAME = "jpctb greenend";
54 private final static String YARRG_CLIENTVERSION =
55 net.chiark.yarrg.Version.version;
56 private final static String YARRG_CLIENTFIXES = "bug-094";
57 private final static String YARRG_LIVE_URL =
58 "http://upload.yarrg.chiark.net/commod-update-receiver";
59 private final static String YARRG_TEST_URL =
60 "http://upload.yarrg.chiark.net/test/commod-update-receiver";
61 private String YARRG_URL;
63 private boolean uploadToYarrg;
64 private boolean uploadToPCTB;
65 private boolean showArbitrage;
67 private String islandName = null;
68 private String oceanName = null;
69 private java.util.concurrent.CountDownLatch latch = null;
71 private AccessibleContext sidePanel;
72 private HashMap<String,Integer> commodMap;
73 public PrintStream dtxt = null;
74 private int uploadcounter = 0;
77 * UTILITY METHODS AND SUBCLASSES
79 * Useable on any thread.
82 private int parseQty(String str) {
83 if (str.equals(">1000")) {
86 return Integer.parseInt(str);
90 private void debuglog(String s) {
91 if (dtxt == null) return;
92 long now = new Date().getTime();
93 dtxt.println("progress "+(now - startTime)+"ms "
94 +Thread.currentThread().getName()+": "+s);
97 private void debug_write_stringdata(String what, String data)
98 throws FileNotFoundException,IOException {
99 if (dtxt==null) return;
100 PrintStream strm = new PrintStream(new File("jarrg-debug-"+what));
105 private void debug_write_bytes(String what, byte[] data)
106 throws FileNotFoundException,IOException {
107 if (dtxt==null) return;
108 FileOutputStream strm = new FileOutputStream(new File("jarrg-debug-"+what));
114 * An abstract market offer, entailing a commodity being bought or sold by
115 * a shoppe, for a certain price in a certain quantity. Not instantiable.
120 abstract class Offer {
121 public int commodity, price, quantity, shoppe;
123 * Create an offer from <code>record</code>, determining the shoppe Id from
124 * <code>stallMap</code> and the commodity Id from <code>commodMap</code>.
125 * <code>priceIndex</code> should be the index of the price in the record
126 * (the quantity will be <code>priceIndex + 1</code>).
128 * @param record the record with data to create the offer from
129 * @param stallMap a map containing the ids of the various stalls
130 * @param commodMap a map containing the ids of the various commodities
131 * @param priceIndex the index of the price in the record
133 public Offer(ArrayList<String> record,
134 LinkedHashMap<String,Integer> stallMap,
135 HashMap<String,Integer> commodMap,
137 Integer commodId = commodMap.get(record.get(0));
138 if(commodId == null) {
139 throw new IllegalArgumentException();
141 commodity = commodId.intValue();
142 price = Integer.parseInt(record.get(priceIndex));
143 String qty = record.get(priceIndex+1);
144 quantity = parseQty(qty);
145 shoppe = stallMap.get(record.get(1)).intValue();
149 * Returns a human-readable version of this offer, useful for debugging
151 * @return human-readable offer
153 public String toString() {
154 return "[C:" + commodity + ",$" + price + ",Q:"
155 + quantity + ",S:" + shoppe + "]";
160 * An offer from a shoppe or stall to buy a certain quantity of a
161 * commodity for a certain price. If placed in an ordered Set,
162 * sorts by commodity index ascending, then by buy price
163 * descending, and finally by stall id ascending.
165 class Buy extends Offer implements Comparable<Buy> {
167 * Creates a new <code>Buy</code> offer from the given
168 * <code>record</code> using the other parameters to determine
169 * stall id and commodity id of the offer.
171 * @param record the record with data to create the offer from
172 * @param stallMap a map containing the ids of the various stalls
173 * @param commodMap a map containing the ids of the various commodities
175 public Buy(ArrayList<String> record,
176 LinkedHashMap<String,Integer> stallMap,
177 HashMap<String,Integer> commodMap) {
178 super(record,stallMap,commodMap,2);
182 * Sorts by commodity index ascending, then price descending,
183 * then stall id ascending.
185 public int compareTo(Buy buy) {
186 // organize by: commodity index, price, stall index
187 if(commodity == buy.commodity) {
188 // organize by price, then by stall index
189 if(price == buy.price) {
190 // organize by stall index
191 return shoppe>buy.shoppe ? 1 : -1;
192 } else if(price > buy.price) {
197 } else if(commodity > buy.commodity) {
206 * An offer from a shoppe or stall to sell a certain quantity of
207 * a commodity for a certain price. If placed in an ordered Set,
208 * sorts by commodity index ascending, then by sell price
209 * ascending, and finally by stall id ascending.
211 class Sell extends Offer implements Comparable<Sell> {
213 * Creates a new <code>Sell</code> offer from the given
214 * <code>record</code> using the other parameters to determine
215 * stall id and commodity id of the offer.
217 * @param record the record with data to create the offer from
218 * @param stallMap a map containing the ids of the various stalls
219 * @param commodMap a map containing the ids of the various commodities
221 public Sell(ArrayList<String> record,
222 LinkedHashMap<String,Integer> stallMap,
223 HashMap<String,Integer> commodMap) {
224 super(record,stallMap,commodMap,4);
228 * Sorts by commodity index ascending, then price ascending, then
229 * stall id ascending.
231 public int compareTo(Sell sell) {
232 // organize by: commodity index, price, stall index
233 if(commodity == sell.commodity) {
234 // organize by price, then by stall index
235 if(price == sell.price) {
236 // organize by stall index
237 return shoppe>sell.shoppe ? 1 : -1;
238 } else if(price > sell.price) {
243 } else if(commodity > sell.commodity) {
251 private void progressNote(final String s_in) throws Exception {
252 new UIA() { public void body() {
254 arb = arbitrageResult.getText();
256 if (arb != null && arb.length() != 0)
257 s = "<html>" + arb + "<br>" + s;
259 }}.exec("progressNote "+s_in);
263 * ENTRY POINT AND STARTUP
265 * Main thread and/or event thread
268 * Entry point. Read our preferences.
270 public MarketUploader() {
271 Preferences prefs = Preferences.userNodeForPackage(getClass());
273 if (prefs.getBoolean("writeDebugFiles", false)) {
275 dtxt = new PrintStream(new File("jarrg-debug-log.txt"));
276 } catch (java.io.FileNotFoundException e) {
277 System.err.println("JARRG: Error opening debug log: "+e);
281 if (prefs.getBoolean("useLiveServers", true)) {
282 YARRG_URL = YARRG_LIVE_URL;
283 PCTB_HOST_URL = PCTB_LIVE_HOST_URL;
285 YARRG_URL = YARRG_TEST_URL;
286 PCTB_HOST_URL = PCTB_TEST_HOST_URL;
289 uploadToYarrg=prefs.getBoolean("uploadToYarrg", true);
290 uploadToPCTB=prefs.getBoolean("uploadToPCTB", true);
291 showArbitrage=prefs.getBoolean("showArbitrage", true);
293 debuglog("main on dispatch thread: "+EventQueue.isDispatchThread());
294 EventQueue.invokeLater(this);
298 * We arrange to wait for the GUI to be initialised, then look at
299 * every top-level window, and if it
302 debuglog("MarketUploader run()...");
303 if (EventQueueMonitor.isGUIInitialized()) {
304 debuglog("MarketUploader GUI already ready");
307 debuglog("MarketUploader waiting for GUI");
308 EventQueueMonitor.addGUIInitializedListener(this);
312 public void guiInitialized() {
313 Window ws[]= EventQueueMonitor.getTopLevelWindows();
314 EventQueueMonitor.addTopLevelWindowListener(this);
315 for (int i=0; i<ws.length; i++) {
316 debuglog("MarketUploader existing toplevel "+i);
317 topLevelWindowCreated(ws[i]);
321 public void topLevelWindowDestroyed(Window w) {
322 debuglog("MarketUploader destroyed toplevel");
325 public void topLevelWindowCreated(Window w) {
329 String name = w.getAccessibleContext().getAccessibleName();
330 debuglog("MarketUploader checking toplevel "+name);
331 if (!name.equals("Puzzle Pirates"))
333 debuglog("MarketUploader found toplevel, creating gui");
336 frame.setVisible(true);
340 * Set up the GUI, with its window and one-button
341 * interface. Only initialize if we're running alongside
342 * a Window named "Puzzle Pirates" though.
344 private void createGUI() {
346 frame = new JFrame("Jarrg Uploader");
347 frame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);
348 GridLayout layout = new GridLayout(2,1);
349 frame.getContentPane().setLayout(layout);
350 //frame.setPreferredSize(new Dimension(200, 60));
352 findMarket = new JButton("Upload Market Data");
353 findMarket.addActionListener(new ActionListener() {
354 public void actionPerformed(ActionEvent e) {
357 findMarket.setEnabled(false);
358 resultSummary.setText("");
359 arbitrageResult.setText("");
360 new Thread("MarketUploader-uploader-"+uploadcounter) {
362 startTime = new Date().getTime();
363 unknownPCTBcommods = 0;
365 runUpload(uploadcounter);
366 } catch(Exception e) {
371 new UIX() { public void body() {
372 if(sidePanel != null) {
373 sidePanel.removePropertyChangeListener(changeListener);
375 if (progmon != null) {
379 findMarket.setEnabled(true);
381 } catch (Exception e) {
382 System.err.println("exception tidying on UI thread:");
389 frame.add(findMarket);
391 resultSummary = new JLabel("ready");
392 frame.add(resultSummary);
394 arbitrageResult = new JLabel("");
397 layout.setRows(layout.getRows() + 1);
398 frame.add(arbitrageResult);
407 * Special measures are needed because:
408 * - it is not permitted to use any Swing UI classes or objects
409 * other than on the Swing event thread
410 * - we want to run our upload asynchronously
411 * - we want to do some computation asynchronously (eg, the
412 * arbitrage and upload data prep)
414 * So what we do is this:
415 * 1. When the user asks to upload, we spawn a new thread
416 * to do the upload ("MarketUploader-uploader-*", see
417 * the call to "new Thread" inside createGUI.
418 * 2. Whenever that thread needs to touch a UI object it
419 * uses EventQueue.invokeLater or .invokeAndWait to
420 * perform the relevant action. We wrap these calls up
421 * in three utility classes:
422 * UIA - runs code on UI thread, asynchronously
423 * UIX - runs code on UI thread, waits for it to finish
424 * UIXR - as UIX but also returns a value
425 * These hide the details of the EventQueue class and also do
426 * some debugging and argument shuffling; the calling syntax is
427 * still painful, unfortunately, and there is a weird constraint
428 * on variables used inside the inner body. For a simple
429 * example, see the handling of "summary" and "summary_final"
430 * for the call to UIX at the bottom of runUpload.
431 * 3. Try to put everything back when that thread exits.
434 * a. There is another thread spawed early to get a timestamp from
435 * YARRG, if we are uploading there.
436 * b. Finding the island name can involve callbacks which run in
437 * the UI event thread. Basically we do the work there, and use
438 * a CountDownLatch to cause the uploader thread to wait as
442 private void on_ui_thread() { assert(EventQueue.isDispatchThread()); }
443 private void on_our_thread() { assert(!EventQueue.isDispatchThread()); }
445 private abstract class UIA implements Runnable {
447 public abstract void body();
449 debuglog("UIA 2 "+what+" begin");
451 debuglog("UIA 3 "+what+" done");
453 public void exec(String what_in) {
455 debuglog("UIA 1 "+what+" request");
456 EventQueue.invokeLater(this);
459 private abstract class UIXR<ReturnType> implements Runnable {
460 public abstract ReturnType bodyr();
461 public ReturnType return_value;
464 debuglog("UIX 2 "+what+" begin");
465 return_value = bodyr();
466 debuglog("UIX 3 "+what+" done");
468 public ReturnType exec(String what_in) throws Exception {
470 if (EventQueue.isDispatchThread()) {
471 debuglog("UIX 1 "+what+" (event thread) entry");
473 debuglog("UIX 4 "+what+" (event thread) exit");
475 debuglog("UIX 1 "+what+" (other thread) entry");
476 EventQueue.invokeAndWait(this);
477 debuglog("UIX 4 "+what+" (other thread) exit");
482 private abstract class UIX extends UIXR<Object> implements Runnable {
483 public abstract void body();
484 public Object bodyr() { body(); return null; }
488 * ERROR REPORTING AND GENERAL UTILITIES
490 * Synchronous modal dialogues
491 * error and error_html may be called from any thread
494 private void error(final String msg) {
496 new UIX() { public void body() {
497 resultSummary.setText("failed");
498 JOptionPane.showMessageDialog(frame,msg,"Error",
499 JOptionPane.ERROR_MESSAGE);
501 } catch (Exception e) {
502 System.err.println("exception reporting to UI thread:");
507 private void error_html(final String msg, String html) {
508 Pattern body = Pattern.compile("<body>(.*)</body>",
509 Pattern.DOTALL | Pattern.CASE_INSENSITIVE);
510 Matcher m = body.matcher(html);
513 Pattern fixup = Pattern.compile("<(\\w+) */>");;
514 m = fixup.matcher(html);
515 html = m.replaceAll("<$1>");
516 m = Pattern.compile("[\\r\\n]+").matcher(html);
517 html = m.replaceAll(" ");
519 String whole_msg = "<html><h1>Error</h1>"+msg
520 +"<h1>PCTB Server said:</h1><blockquote>"+html+"</blockquote>";
521 debuglog("###" + whole_msg + "###");
526 private void setProgress(final int nv) throws Exception {
527 new UIA() { public void body() {
528 progmon.setProgress(nv);
529 }}.exec("setProgress "+nv);
531 private boolean checkCancelled() throws Exception {
532 return new UIXR<Boolean>() { public Boolean bodyr() {
533 boolean can = progmon.isCanceled();
534 if (can) resultSummary.setText("cancelled");
535 return new Boolean(can);
536 }}.exec("checkCancelled").booleanValue();
540 * GUI MANIPULATION CALLBACKS
543 private PropertyChangeListener changeListener = new PropertyChangeListener() {
544 public void propertyChange(PropertyChangeEvent e) {
546 if(e.getNewValue() != null &&
547 e.getPropertyName().equals
548 (AccessibleContext.ACCESSIBLE_CHILD_PROPERTY)) {
549 Accessible islandInfo =
550 descendNodes(window,new int[] {0,1,0,0,2,2,0,0,0,0,1,2});;
551 String text = islandInfo.getAccessibleContext().getAccessibleText()
552 .getAtIndex(AccessibleText.SENTENCE,0);
553 int index = text.indexOf(":");
554 String name = text.substring(0,index);
556 // debuglog(islandName);
557 sidePanel.removePropertyChangeListener(this);
563 private void getIsland() {
566 // If the league tracker is there, we can skip the faff
567 // and ask for its tooltip, since we're on a boat
569 Accessible leagueTrackerContainer =
570 descendNodes(window,new int[] {0,1,0,0,2,1});
571 Accessible leagueTrackerItself =
572 descendByClass(leagueTrackerContainer,
573 "com.threerings.yohoho.sea.client.LeagueTracker");
574 Accessible leagueTracker = descend(leagueTrackerItself, 1);
576 islandName = ((JLabel)leagueTracker).getToolTipText();
577 } catch (NullPointerException e) {
578 // evidently we're actually on an island
581 AccessibleContext chatArea =
582 descendNodes(window,new int[] {0,1,0,0,0,2,0,0,2})
583 .getAccessibleContext();
584 // attach the property change listener to the outer sunshine
585 // panel if the "ahoy" tab is not active, otherwise attach it to
586 // the scroll panel in the "ahoy" tab.
587 if(!"com.threerings.piracy.client.AttentionListPanel".
588 equals(descendNodes(window,new int[] {0,1,0,0,2,2,0})
589 .getClass().getCanonicalName())) {
590 sidePanel = descendNodes(window,new int[] {0,1,0,0,2,2})
591 .getAccessibleContext();
593 sidePanel = descendNodes(window,new int[] {0,1,0,0,2,2,0,0,0})
594 .getAccessibleContext();
596 sidePanel.addPropertyChangeListener(changeListener);
597 latch = new java.util.concurrent.CountDownLatch(1);
598 // make the Players Online ("/who") panel appear
599 AccessibleEditableText chat = chatArea.getAccessibleEditableText();
600 chat.setTextContents("/w");
601 int c = chatArea.getAccessibleAction().getAccessibleActionCount();
602 for(int i=0;i<c;i++) {
603 if("notify-field-accept".equals(chatArea.getAccessibleAction()
604 .getAccessibleActionDescription(i))) {
605 chatArea.getAccessibleAction().doAccessibleAction(i);
612 * Find the ocean name from the window title, and set global
615 private void getOcean() {
618 AccessibleContext topwindow = window.getAccessibleContext();
619 oceanName = topwindow.getAccessibleName()
620 .replaceAll(".*on the (\\w+) ocean", "$1");
625 * Run the data collection process, and upload the results. This
626 * is the method that calls most of the other worker methods for
627 * the process. If an error occurs, the method will call the
628 * error method and return early, freeing up the button to be
631 * @exception Exception if an error we didn't expect occured
633 private class YarrgTimestampFetcher extends Thread {
634 public YarrgTimestampFetcher(int counter) {
635 super("MarketUploader-YarrgTimestampFetcher-"+uploadcounter);
637 public String ts = null;
640 ts = getYarrgTimestamp();
641 debuglog("(async) yarrg timestamp ready.");
642 } catch(Exception e) {
643 error("Error getting YARRG timestamp: "+e);
648 private void runUpload(int counter) throws Exception {
651 boolean doneyarrg = false, donepctb = false;
652 YarrgTimestampFetcher yarrgts_thread = null;
654 debuglog("starting");
657 debuglog("(async) yarrg timestamp...");
658 yarrgts_thread = new YarrgTimestampFetcher(counter);
659 yarrgts_thread.start();
662 final AccessibleTable accesstable =
663 new UIXR<AccessibleTable>() { public AccessibleTable bodyr() {
664 progmon = new ProgressMonitor
665 (frame,"Processing Market Data","Getting table data",0,100);
666 progmon.setMillisToDecideToPopup(0);
667 progmon.setMillisToPopup(0);
669 AccessibleTable at = findMarketTable();
671 error("Market table not found!"+
672 " Please open the Buy/Sell Commodities interface.");
675 if(at.getAccessibleRowCount() == 0) {
676 error("No data found, please wait for the table to have data first!");
679 if(!isDisplayAll()) {
680 error("Please select \"All\" from the Display: popup menu.");
684 debuglog("(async) getisland...");
686 debuglog("getocean...");
688 debuglog("getocean done");
691 }}.exec("accesstable");
692 if (accesstable == null) return;
695 latch.await(2, java.util.concurrent.TimeUnit.SECONDS);
697 debuglog("(async) getisland done");
699 String yarrgts = null;
700 if (yarrgts_thread != null) {
701 debuglog("(async) yarrg timestamp join...");
702 yarrgts_thread.join();
703 debuglog("(async) yarrg timestamp joined.");
704 yarrgts = yarrgts_thread.ts;
707 if (islandName == null) {
708 error("Could not find island name in YPP user interface.");
712 debuglog("table check...");
714 final ArrayList<ArrayList<String>> data =
715 new UIXR<ArrayList<ArrayList<String>>>
716 () { public ArrayList<ArrayList<String>> bodyr() {
717 String headings_expected[] = new String[]
718 { "Commodity", "Trading outlet", "Buy price",
719 "Will buy", "Sell price", "Will sell" };
721 ArrayList<ArrayList<String>> headers =
722 getData(accesstable.getAccessibleColumnHeader());
723 if (headers.size() != 1) {
724 error("Table headings not one row! " + headers.toString());
727 if (headers.get(0).size() < 6 ||
728 headers.get(0).size() > 7) {
729 error("Table headings not six or seven columns! " + headers.toString());
732 for (int col=0; col<headings_expected.length; col++) {
733 String expd = headings_expected[col];
734 String got = headers.get(0).get(col);
735 if (expd.compareTo(got) != 0) {
736 error("Table heading for column "+col
737 +" is not \""+expd+"\" but \""+got+"\".\n\n"
738 +"Please do not reorder the table when using this tool.");
743 debuglog("table read...");
745 return getData(accesstable);
747 if (data == null) return;
750 debuglog("arbitrage...");
751 calculateArbitrage(data);
752 debuglog("arbitrage done.");
755 if (uploadToYarrg && yarrgts != null) {
756 debuglog("yarrg prepare...");
757 progressNote("Yarrg: Preparing data");
760 StringBuilder yarrgsb = new StringBuilder();
761 String yarrgdata; // string containing what we'll feed to yarrg
763 for (ArrayList<String> row : data) {
764 if (row.size() > 6) {
767 for (String rowitem : row) {
768 yarrgsb.append(rowitem != null ? rowitem : "");
769 yarrgsb.append("\t");
771 yarrgsb.setLength(yarrgsb.length()-1); // chop
772 yarrgsb.append("\n");
775 yarrgdata = yarrgsb.toString();
777 progressNote("Yarrg: Uploading");
778 debuglog("yarrg upload...");
780 doneyarrg = runYarrg(yarrgts, oceanName, islandName, yarrgdata);
781 debuglog("yarrg done.");
785 debuglog("pctb prepare...");
786 progressNote("PCTB: Getting stall names");
788 if(checkCancelled()) {
791 TreeSet<Offer> buys = new TreeSet<Offer>();
792 TreeSet<Offer> sells = new TreeSet<Offer>();
793 LinkedHashMap<String,Integer> stallMap = getStallMap(data);
795 progressNote("PCTB: Sorting offers");
796 if(checkCancelled()) {
801 debuglog("pctb commodmap...");
802 HashMap<String,Integer> commodMap = getCommodMap();
803 if(commodMap == null) {
806 debuglog("pctb commodmap done.");
807 int[] offerCount = getBuySellMaps(data,buys,sells,stallMap,commodMap);
809 // debuglog("\n\n\n"+buys);
811 ByteArrayOutputStream outStream = new ByteArrayOutputStream();
813 progressNote("PCTB: Sending data");
814 if(checkCancelled()) {
817 GZIPOutputStream out = new GZIPOutputStream(outStream);
818 DataOutputStream dos = new DataOutputStream(out);
819 dos.writeBytes("005y\n");
820 dos.writeBytes(stallMap.size()+"\n");
821 dos.writeBytes(getAbbrevStallList(stallMap));
822 writeBuySellOffers(buys,sells,offerCount,out);
824 debuglog("pctb send...");
826 byte[] ba = outStream.toByteArray();
827 debug_write_bytes("pctb-marketdata.gz", ba);
829 InputStream in = sendInitialData(new ByteArrayInputStream(ba));
830 debuglog("pctb sent.");
831 if (in == null) return;
833 if(checkCancelled()) {
836 progressNote("PCTB: Waiting ...");
837 debuglog("pctb finish...");
838 donepctb = finishUpload(in);
839 debuglog("pctb done.");
844 if ((uploadToPCTB && !donepctb) ||
845 (uploadToYarrg && !doneyarrg)) {
847 } else if (unknownPCTBcommods != 0) {
848 summary= "PCTB lacks "+unknownPCTBcommods+" commod(s)";
849 } else if (donepctb || doneyarrg) {
850 summary= "Done " + islandName;
852 summary= "uploaded nowhere!";
854 final String summary_final = summary;
855 new UIX() { public void body() {
856 resultSummary.setText(summary_final);
857 }}.exec("resultSummary.setText");
863 * Get the offer data out of the table and cache it in an
864 * <code>ArrayList</code>.
866 * @param table the <code>AccessibleTable</code> containing the market data
867 * @return an array of record arrays, each representing a row of the table
869 private ArrayList<ArrayList<String>> getData(AccessibleTable table) {
871 ArrayList<ArrayList<String>> data = new ArrayList<ArrayList<String>>();
872 for (int i = 0; i < table.getAccessibleRowCount(); i++) {
873 ArrayList<String> row = new ArrayList<String>();
874 for (int j = 0; j < table.getAccessibleColumnCount(); j++) {
875 row.add(table.getAccessibleAt(i, j)
876 .getAccessibleContext().getAccessibleName());
884 * @return the table containing market data if it exists,
885 * otherwise <code>null</code>
887 public AccessibleTable findMarketTable() {
889 Accessible node1 = window;
890 Accessible node = descendNodes(node1,new int[] {0,1,0,0,0,0,1,0,0,1,0,0});
892 // 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})
894 if (!(node instanceof JTable)) {
895 node = descendNodes(node1,new int[] {0,1,0,0,0,0,1,0,1,0,0,1,0,0});
898 if (!(node instanceof JTable)) return null;
899 AccessibleTable table = node.getAccessibleContext().getAccessibleTable();
905 * Utility method to descend through several levels of Accessible children
908 * @param parent the node on which to start the descent
909 * @param path an array of ints, each int being the index of the next
910 * accessible child to descend.
911 * @return the <code>Accessible</code> reached by following the
912 * descent path, or <code>null</code> if the desired path was
915 private Accessible descendNodes(Accessible parent, int[] path) {
917 for(int i=0;i<path.length;i++) {
918 if (null == (parent = descend(parent, path[i]))) return null;
924 * Descends one level to the specified child of the parent
925 * <code>Accessible</code> "node".
927 * @param parent the node with children
928 * @param childNum the index of the child of <code>parent</code> to return
929 * @return the <code>childNum</code> child of <code>parent</code>
930 * or <code>null</code> if the child is not found.
932 private Accessible descend(Accessible parent, int childNum) {
934 if (parent == null) return null;
935 int children = parent.getAccessibleContext().getAccessibleChildrenCount();
936 if (childNum >= children) {
937 debuglog("DESCEND "+childNum+" > "+children+" NOT FOUND");
940 Accessible child = parent.getAccessibleContext()
941 .getAccessibleChild(childNum);
942 debuglog("DESCEND "+childNum+" "+child.getClass().getName()+" OK");
947 * Descends one level to the child which has the specified class.
949 * @param parent the node with children
950 * @param classname the name of the class, as a string
951 * @return the child or <code>null</code> if the child is not found.
953 private Accessible descendByClass(Accessible parent, String classname) {
955 if (parent == null) return null;
956 AccessibleContext ac = parent.getAccessibleContext();
957 int children = ac.getAccessibleChildrenCount();
958 for (int i=0; i<children; i++) {
959 Accessible child = ac.getAccessibleChild(i);
960 if (child.getClass().getName() == classname) {
961 debuglog("DESCEND CLASS "+classname+" OK");
965 debuglog("DESCEND CLASS "+classname+" NOT FOUND");
969 public static void main(String[] args) {
970 new MarketUploader();
974 * Returns true if the "Display:" menu on the commodities
975 * interface in YPP is set to "All"
977 * @return <code>true</code> if all commodities are displayed,
978 * otherwise <code>false</code>
980 private boolean isDisplayAll() {
982 Accessible button = descendNodes(window,new int[] {0,1,0,0,0,0,1,0,0,0,1});
983 if(!(button instanceof JButton)) {
984 button = descendNodes(window,new int[] {0,1,0,0,0,0,1,0,1,0,0,0,1});
986 String display = button.getAccessibleContext().getAccessibleName();
987 if(!display.equals("All")) {
994 * Gets the list of commodities and their associated commodity ids.
996 * @return a map where the key is the commodity and the value is
999 private HashMap<String,Integer> getCommodMap() {
1001 if(commodMap != null) {
1004 HashMap<String,Integer> map = new HashMap<String,Integer>();
1007 URL host = new URL(PCTB_HOST_URL + "commodmap.php");
1009 new BufferedReader(new InputStreamReader(host.openStream()));
1010 StringBuilder sb = new StringBuilder();
1012 while((str = br.readLine()) != null) {
1016 debug_write_stringdata("pctb-commodmap.xmlish", sb.toString());
1017 int first = sb.indexOf("<pre>") + 5;
1018 int last = sb.indexOf("</body>");
1019 xml = sb.substring(first,last);
1020 Reader reader = new CharArrayReader(xml.toCharArray());
1021 Document d = DocumentBuilderFactory.newInstance()
1022 .newDocumentBuilder().parse(new InputSource(reader));
1023 NodeList maps = d.getElementsByTagName("CommodMap");
1024 for(int i=0;i<maps.getLength();i++) {
1025 NodeList content = maps.item(i).getChildNodes();
1026 Integer num = Integer.parseInt(content.item(1).getTextContent());
1027 map.put(content.item(0).getTextContent(),num);
1029 } catch(Exception e) {
1030 e.printStackTrace();
1031 error("Unable to load Commodity list from server!");
1039 * Given the list of offers, this method will find all the unique
1040 * stall names and return them in a <code>LinkedHashMap</code>
1041 * where the key is the stall name and the value is the generated
1042 * stall id (position in the list). <p> The reason this method
1043 * returns a LinkedHashMap instead of a simple HashMap is the
1044 * need for iterating over the stall names in insertion order for
1045 * output to the server.
1047 * @param offers the list of records from the commodity buy/sell interface
1048 * @return an iterable ordered map of the stall names and
1049 * generated stall ids
1051 private LinkedHashMap<String,Integer> getStallMap
1052 (ArrayList<ArrayList<String>> offers) {
1054 LinkedHashMap<String,Integer> map = new LinkedHashMap<String,Integer>();
1055 for(ArrayList<String> offer : offers) {
1056 String shop = offer.get(1);
1057 if(!map.containsKey(shop)) {
1059 map.put(shop,count);
1066 * Gets a sorted list of Buys and Sells from the list of
1067 * records. <code>buys</code> and <code>sells</code> should be
1068 * pre-initialized and passed into the method to receive the
1069 * data. Returns a 2-length int array with the number of buys
1072 * @param offers the data found from the market table in-game
1073 * @param buys an empty initialized <code>TreeSet<Offer></code> to
1074 * hold the Buy offers.
1075 * @param sells an empty initialized <code>TreeSet<Offer></code> to
1076 * hold the Sell offers.
1077 * @param stalls the map of stalls to their ids
1078 * @param commodMap the map of commodities to their ids
1079 * @return a 2-length int[] array containing the number of buys
1080 * and sells, respectively
1082 private int[] getBuySellMaps(ArrayList<ArrayList<String>> offers,
1083 TreeSet<Offer> buys,
1084 TreeSet<Offer> sells,
1085 LinkedHashMap<String,Integer> stalls,
1086 HashMap<String,Integer> commodMap) {
1087 int[] buySellCount = new int[2];
1088 for(ArrayList<String> offer : offers) {
1090 if(offer.get(2) != null) {
1091 buys.add(new Buy(offer,stalls,commodMap));
1094 if(offer.get(4) != null) {
1095 sells.add(new Sell(offer,stalls,commodMap));
1098 } catch(IllegalArgumentException e) {
1099 unknownPCTBcommods++;
1100 debuglog("Error: Unsupported Commodity \"" + offer.get(0) + "\"");
1103 if (buySellCount[0]==0 && buySellCount[1]==0) {
1104 error("No (valid) offers for PCTB?!");
1105 throw new IllegalArgumentException();
1107 return buySellCount;
1111 * Prepares the list of stalls for writing to the output stream.
1112 * The <code>String</code> returned by this method is ready to be
1113 * written directly to the stream. <p> All shoppe names are left
1114 * as they are. Stall names are abbreviated just before the
1115 * apostrophe in the possessive, with an "^" and a letter
1116 * matching the stall's type appended. Example: "Burninator's
1117 * Ironworking Stall" would become "Burninator^I".
1119 * @param stallMap the map of stalls and stall ids in an iterable order
1120 * @return a <code>String</code> containing the list of stalls in
1121 * format ready to be written to the output stream.
1123 private String getAbbrevStallList(LinkedHashMap<String,Integer> stallMap) {
1124 // set up some mapping
1125 HashMap<String,String> types = new HashMap<String,String>();
1126 types.put("Apothecary Stall", "A");
1127 types.put("Distilling Stall", "D");
1128 types.put("Furnishing Stall", "F");
1129 types.put("Ironworking Stall", "I");
1130 types.put("Shipbuilding Stall", "S");
1131 types.put("Tailoring Stall", "T");
1132 types.put("Weaving Stall", "W");
1134 StringBuilder sb = new StringBuilder();
1135 for(String name : stallMap.keySet()) {
1136 int index = name.indexOf("'s");
1137 String finalName = name;
1140 finalName = name.substring(0,index);
1141 if(index + 2 < name.length()) {
1142 String end = name.substring(index+2,name.length()).trim();
1143 type = types.get(end);
1147 sb.append(name+"\n");
1149 sb.append(finalName+"^"+type+"\n");
1152 return sb.toString();
1156 * Writes a list of offers in correct format to the output stream.
1158 * The format is thus: (all numbers are 2-byte integers in
1159 * little-endian format) (number of offers of this type, aka
1160 * buy/sell) (commodity ID) (number of offers for this commodity)
1161 * [shopID price qty][shopID price qty]...
1163 * @param out the output stream to write the data to
1164 * @param offers the offers to write
1166 private void writeOffers(OutputStream out, TreeSet<Offer> offers)
1167 throws IOException {
1168 ByteArrayOutputStream buffer = new ByteArrayOutputStream();
1169 if(offers.size() == 0) {
1170 // nothing to write, and "0" has already been written
1173 int commodity = offers.first().commodity;
1175 for(Offer offer : offers) {
1176 if(commodity != offer.commodity) {
1178 writeBufferedOffers(out,buffer.toByteArray(),commodity,count);
1180 commodity = offer.commodity;
1183 writeLEShort(offer.shoppe,buffer); // stall index
1184 writeLEShort(offer.price,buffer); // buy price
1185 writeLEShort(offer.quantity,buffer); // buy qty
1188 writeBufferedOffers(out,buffer.toByteArray(),commodity,count);
1192 * Writes the buffered data to the output strea for one commodity.
1194 * @param out the stream to write to
1195 * @param buffer the buffered data to write
1196 * @param commodity the commmodity id to write before the buffered data
1197 * @param count the number of offers for this commodity to write
1200 private void writeBufferedOffers(OutputStream out, byte[] buffer,
1201 int commodity, int count)
1202 throws IOException {
1203 writeLEShort(commodity,out); // commod index
1204 writeLEShort(count,out); // offer count
1205 out.write(buffer); // the buffered offers
1209 * Writes the buy and sell offers to the outputstream by calling
1212 * @param buys list of Buy offers to write
1213 * @param sells list of Sell offers to write
1214 * @param offerCount 2-length int array containing the number of
1215 * buys and sells to write out
1216 * @param out the stream to write to
1218 private void writeBuySellOffers(TreeSet<Offer> buys,
1219 TreeSet<Offer> sells,
1220 int[] offerCount, OutputStream out)
1221 throws IOException {
1223 writeLEShort(offerCount[0],out);
1224 writeOffers(out,buys);
1226 writeLEShort(offerCount[1],out);
1227 writeOffers(out,sells);
1230 private String readstreamstring(InputStream in) throws IOException {
1231 StringBuilder sb = new StringBuilder();
1232 BufferedReader br = new BufferedReader(new InputStreamReader(in));
1234 while((str = br.readLine()) != null) {
1235 sb.append(str+"\n");
1237 return sb.toString();
1241 * Sends the data to the server via multipart-formdata POST,
1242 * with the gzipped data as a file upload.
1244 * @param file an InputStream open to the gzipped data we want to send
1246 private InputStream sendInitialData(InputStream file) throws IOException {
1248 ClientHttpRequest http =
1249 new ClientHttpRequest(PCTB_HOST_URL + "upload.php");
1250 http.setParameter("marketdata","marketdata.gz",file,"application/gzip");
1252 String err = readstreamstring(http.resultstream());
1253 error("Error sending initial data:\n"+err);
1256 return http.resultstream();
1260 * Utility method to write a 2-byte int in little-endian form to
1263 * @param num an integer to write
1264 * @param out stream to write to
1266 private void writeLEShort(int num, OutputStream out) throws IOException {
1267 out.write(num & 0xFF);
1268 out.write((num >>> 8) & 0xFF);
1272 * Reads the response from the server, and selects the correct parameters
1273 * which are sent in a GET request to the server asking it to confirm
1274 * the upload and accept the data into the database. Notably, the island id
1275 * and ocean id are determined, while other parameter such as the filename
1276 * are determined from the hidden form fields.
1278 * @param in stream of data from the server to read
1280 private boolean finishUpload(InputStream in) throws IOException {
1283 String html = readstreamstring(in);
1284 debug_write_stringdata("pctb-initial.html", html);
1287 Pattern params = Pattern.compile
1288 ("(?s)<input type=\"hidden\" name=\"action\" value=\"setisland\" />"+
1289 ".+?<input type=\"hidden\" name=\"forcereload\" value=\"([^\"]+)\" />"+
1290 ".+?<input type=\"hidden\" name=\"filename\" value=\"([^\"]+)\" />");
1291 m = params.matcher(html);
1293 error_html("The PCTB server returned unusual data."+
1294 " Maybe you're using an old version of the uploader?",
1298 String forceReload = m.group(1);
1299 String filename = m.group(2);
1301 Pattern oceanNumPat =
1302 Pattern.compile("<option value=\"(\\d+)\">"+oceanName+"</option>");
1303 m = oceanNumPat.matcher(html);
1305 error_html("Unable to find the ocean in the server's list of oceans!",
1309 String oceanNum = m.group(1);
1311 Pattern oceanIslandNum =
1312 Pattern.compile("islands\\[" + oceanNum
1313 + "\\]\\[\\d+\\]=new Option\\(\"" + islandName
1315 m = oceanIslandNum.matcher(html);
1317 error_html("This does not seem to be a valid island! Unable to upload.",
1321 String islandNum = m.group(1);
1323 URL get = new URL(PCTB_HOST_URL +
1324 "upload.php?action=setisland&ocean=" + oceanNum
1325 + "&island=" + islandNum
1326 + "&forcereload=" + forceReload
1327 + "&filename=" + filename);
1328 String complete = readstreamstring(get.openStream());
1329 debug_write_stringdata("pctb-final.html", complete);
1330 Pattern done = Pattern.compile
1331 ("Your data has been integrated into the database. Thank you!");
1332 m = done.matcher(complete);
1336 error_html("Something was wrong with the final upload parameters!",
1342 private InputStream post_for_yarrg(ClientHttpRequest http)
1343 throws IOException {
1346 String err = readstreamstring(http.resultstream());
1347 error("<html><h1>Error reported by YARRG server</h1>\n" + err);
1350 return http.resultstream();
1353 private String getYarrgTimestamp() throws IOException {
1354 ClientHttpRequest http = new ClientHttpRequest (YARRG_URL);
1355 http.setParameter("clientname", YARRG_CLIENTNAME);
1356 http.setParameter("clientversion", YARRG_CLIENTVERSION);
1357 http.setParameter("clientfixes", YARRG_CLIENTFIXES);
1358 http.setParameter("requesttimestamp", "y");
1359 InputStream in = post_for_yarrg(http);
1360 if (in == null) return null;
1361 BufferedReader br = new BufferedReader(new InputStreamReader(in));
1362 String tsresult = br.readLine();
1363 return tsresult.substring(3, tsresult.length()-1);
1366 private boolean runYarrg(String timestamp, String ocean, String island,
1367 String yarrgdata) throws IOException {
1368 ByteArrayOutputStream bos = new ByteArrayOutputStream();
1369 BufferedOutputStream bufos =
1370 new BufferedOutputStream(new GZIPOutputStream(bos));
1371 bufos.write(yarrgdata.getBytes() );
1373 byte[] compressed = bos.toByteArray();
1374 debug_write_bytes("yarrg-deduped.tsv.gz", compressed);
1375 ByteArrayInputStream file = new ByteArrayInputStream(compressed);
1377 ClientHttpRequest http = new ClientHttpRequest (YARRG_URL);
1378 http.setParameter("clientname", YARRG_CLIENTNAME);
1379 http.setParameter("clientversion", YARRG_CLIENTVERSION);
1380 http.setParameter("clientfixes", YARRG_CLIENTFIXES);
1381 http.setParameter("timestamp", timestamp);
1382 http.setParameter("ocean", ocean);
1383 http.setParameter("island", island);
1384 http.setParameter("data", "deduped.tsv.gz", file,
1385 "application/octet-stream");
1386 InputStream in = post_for_yarrg(http);
1387 if (in == null) return false;
1388 String output = readstreamstring(in);
1389 if (!output.startsWith("OK")) {
1390 error("<html><h1>Unexpected output from YARRG server</h1>\n" + output);
1393 debug_write_stringdata("yarrg-result.txt", output);
1397 private int calculateArbitrageCommodity(ArrayList<SortedSet<int[]>> arb_bs) {
1398 // debuglog("ARBITRAGE?");
1400 SortedSet<int[]> buys = arb_bs.get(0);
1401 SortedSet<int[]> sells = arb_bs.get(1);
1405 // NB "sell" means they sell, ie we buy
1406 sell = sells.last();
1408 } catch (NoSuchElementException e) {
1412 int unitprofit = buy[0] - sell[0];
1413 int count = buy[1] < sell[1] ? buy[1] : sell[1];
1414 // debuglog(" sell @"+sell[0]+" x"+sell[1]
1415 // +" buy @"+buy[0]+" x"+buy[1]
1416 // +" => x"+count+" @"+unitprofit);
1418 if (unitprofit <= 0)
1421 profit += count * unitprofit;
1424 if (buy[1]==0) buys.remove(buy);
1425 if (sell[1]==0) sells.remove(sell);
1427 // debuglog(" PROFIT "+profit);
1431 private class arbitrageOfferComparator implements Comparator {
1432 public int compare(Object o1, Object o2) {
1433 int p1 = ((int[])o1)[0];
1434 int p2 = ((int[])o2)[0];
1439 private @SuppressWarnings("unchecked")
1440 void calculateArbitrage(ArrayList<ArrayList<String>> data)
1441 throws InterruptedException {
1443 ArrayList<SortedSet<int[]>> arb_bs = null;
1444 String lastcommod = null;
1445 Comparator compar = new arbitrageOfferComparator();
1447 for (ArrayList<String> row : data) {
1448 String thiscommod = row.get(0);
1449 // debuglog("ROW "+row.toString());
1450 if (lastcommod == null || !thiscommod.equals(lastcommod)) {
1451 if (lastcommod != null)
1452 arbitrage += calculateArbitrageCommodity(arb_bs);
1453 // debuglog("ROW rdy");
1454 arb_bs = new ArrayList<SortedSet<int[]>>(2);
1455 arb_bs.add(0, new TreeSet<int[]>(compar));
1456 arb_bs.add(1, new TreeSet<int[]>(compar));
1457 // debuglog("ROW init");
1458 lastcommod = thiscommod;
1460 for (int bs = 0; bs < 2; bs++) {
1461 String pricestr = row.get(bs*2 + 2);
1462 if (pricestr == null)
1464 int[] entry = new int[2];
1465 // debuglog("ROW BS "+bs);
1466 entry[0] = parseQty(pricestr);
1467 entry[1] = parseQty(row.get(bs*2 + 3));
1468 arb_bs.get(bs).add(entry);
1471 arbitrage += calculateArbitrageCommodity(arb_bs);
1473 if (arbitrage != 0) {
1474 arb = "<html><strong>arbitrage: "+arbitrage+" poe</strong>";
1476 arb = "no arbitrage";
1478 final String arb_final = arb;
1479 EventQueue.invokeLater(new Runnable() { public void run() {
1480 arbitrageResult.setText(arb_final);