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