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