source: trunk/autoquest-htmlmonitor/src/main/java/de/ugoe/cs/autoquest/htmlmonitor/HtmlMonitorServlet.java @ 1228

Last change on this file since 1228 was 1228, checked in by pharms, 11 years ago
  • improved error messages for invalid data
File size: 31.2 KB
Line 
1//   Copyright 2012 Georg-August-Universität Göttingen, Germany
2//
3//   Licensed under the Apache License, Version 2.0 (the "License");
4//   you may not use this file except in compliance with the License.
5//   You may obtain a copy of the License at
6//
7//       http://www.apache.org/licenses/LICENSE-2.0
8//
9//   Unless required by applicable law or agreed to in writing, software
10//   distributed under the License is distributed on an "AS IS" BASIS,
11//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12//   See the License for the specific language governing permissions and
13//   limitations under the License.
14
15package de.ugoe.cs.autoquest.htmlmonitor;
16
17import java.io.BufferedReader;
18import java.io.FileNotFoundException;
19import java.io.IOException;
20import java.io.InputStream;
21import java.io.InputStreamReader;
22import java.io.PrintWriter;
23import java.net.MalformedURLException;
24import java.net.URL;
25import java.util.ArrayList;
26import java.util.List;
27import java.util.Map;
28import java.util.Set;
29
30import javax.servlet.ServletException;
31import javax.servlet.http.HttpServletRequest;
32import javax.servlet.http.HttpServletResponse;
33
34import org.json.simple.JSONArray;
35import org.json.simple.JSONObject;
36import org.json.simple.JSONValue;
37import org.json.simple.parser.ParseException;
38import org.mortbay.jetty.servlet.DefaultServlet;
39
40import de.ugoe.cs.util.FileTools;
41import de.ugoe.cs.util.console.Console;
42
43/**
44 * <p>
45 * the servlet deployed in the web server that receives all client messages and returns the client
46 * java script. The messages are parsed, validated, and forwarded to the provided message listener.
47 * If a message is not valid, it is discarded. If an event in a message is not valid, it is
48 * discarded. Messages are only received via the POST HTTP method. The GET HTTP method is only
49 * implemented for returning the client java script.
50 * </p>
51 *
52 * @author Patrick Harms
53 */
54class HtmlMonitorServlet extends DefaultServlet {
55
56    /**  */
57    private static final long serialVersionUID = 1L;
58   
59    /**  */
60    private static final boolean DO_TRACE = false;
61   
62    /**
63     * <p>
64     * Name and path of the robot filter.
65     * </p>
66     */
67    private static final String ROBOTFILTERFILE = "data/robots/robotfilter.txt";
68
69    /**
70     * <p>
71     * Field that contains a regular expression that matches all robots
72     * contained in {@link #ROBOTFILTERFILE}.
73     * </p>
74     */
75    private String robotRegex = null;
76
77    /**
78     * the message listener to forward received messages to.
79     */
80    private transient HtmlGUIElementManager guiElementManager = new HtmlGUIElementManager();
81
82    /**
83     * the message listener to forward received messages to.
84     */
85    private transient HtmlMonitorMessageListener messageListener;
86
87    /**
88     * <p>
89     * initializes the servlet with the message listener to which all events shall be forwarded
90     * </p>
91     *
92     * @param messageListener the message listener that shall receive all client events
93     */
94    HtmlMonitorServlet(HtmlMonitorMessageListener messageListener) {
95        this.messageListener = messageListener;
96        try {
97            loadRobotRegex();
98        }
99        catch (Exception e) {
100            Console.println
101                ("robot filtering disabled: could not parse robot filter file " + ROBOTFILTERFILE);
102        }
103    }
104
105    /**
106     * this implements handling of doGet. For this servlet this means that
107     * the autoquest-htmlmonitor.js will be delivered to the instance
108     * which sent the get request.
109     *
110     *
111     *  (non-Javadoc)
112     * @see org.mortbay.jetty.servlet.DefaultServlet#doGet(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
113     */
114    @Override
115    protected void doGet(HttpServletRequest request, HttpServletResponse response)
116        throws ServletException, IOException
117    {
118        if ((request.getPathInfo() != null) &&
119            (request.getPathInfo().endsWith("/script/autoquest-htmlmonitor.js")))
120        {
121            BufferedReader reader = null;
122           
123            try {
124                InputStream script = this.getClass().getClassLoader().getResourceAsStream
125                     ("autoquest-htmlmonitor.js");
126               
127                if (script == null) {
128                    Console.printerrln("could not read autoquest-htmlmonitor.js from classpath");
129                }
130                else {
131                    reader = new BufferedReader(new InputStreamReader(script, "UTF-8"));
132                    PrintWriter output = response.getWriter();
133                    String line;
134                   
135                    while ((line = reader.readLine()) != null) {
136                        output.println(line);
137                    }
138                   
139                    output.close();
140                }
141            }
142            catch (Exception e) {
143                Console.printerrln("could not read autoquest-htmlmonitor.js from classpath: " + e);
144                Console.logException(e);
145            }
146            finally {
147                if (reader != null) {
148                    reader.close();
149                }
150            }
151        }
152    }
153
154    /**
155     * this implements handling of doPost. For this servlet this means that
156     * the data from the post request will be parsed and validated.
157     *
158     * (non-Javadoc)
159     * @see org.mortbay.jetty.servlet.DefaultServlet#doPost(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
160     */
161    @Override
162    protected void doPost(HttpServletRequest request, HttpServletResponse response)
163        throws ServletException, IOException
164    {
165        Object value = null;
166        try {
167            //InputStream requestInputStream = dumpStreamContent(request.getInputStream());
168            InputStream requestInputStream = request.getInputStream();
169
170            value = JSONValue.parseWithException
171                (new InputStreamReader(requestInputStream, "UTF-8"));
172           
173            if (!(value instanceof JSONObject)) {
174                Console.printerrln("incoming data is not of the expected type --> discarding it");
175            }
176            else {
177                handleJSONObject((JSONObject) value);
178            }
179        }
180        catch (ParseException e) {
181            Console.printerrln
182                ("could not parse incoming data --> discarding it (" + e.toString() + ")");
183        }
184    }
185
186    /**
187     * <p>
188     * processes a received JSON object and validates it. If the message is ok, it is forwarded
189     * to the message listener
190     * </p>
191     *
192     * @param object the JSON object that contains a client message
193     */
194    private void handleJSONObject(JSONObject object) {
195        if (DO_TRACE) {
196            dumpJSONObject(object, "");
197        }
198       
199        JSONObject message = assertValue(object, "message", JSONObject.class);
200       
201        if (message == null) {
202            Console.printerrln("incoming data is no valid message --> discarding it");
203        }
204        else {
205            HtmlClientInfos clientInfos = extractClientInfos(message);
206
207            if (clientInfos == null) {
208                Console.printerrln
209                    ("incoming message does not contain valid client infos --> discarding it");
210            }
211            else if (isRobot(clientInfos.getUserAgent())) {
212                Console.printerrln
213                    ("ignoring robot " + clientInfos.getUserAgent());
214            }
215            else {
216                HtmlGUIElement guiStructure = extractHtmlPageElements(message, clientInfos);
217                HtmlEvent[] events = extractHtmlEvents(message, clientInfos);
218               
219                if (events == null) {
220                    Console.printerrln
221                        ("incoming message does not contain valid events --> discarding it");
222                }
223                else {
224                    messageListener.handleMessage(clientInfos, guiStructure, events);
225                }
226            }
227        }
228    }
229
230    /**
231     * <p>
232     * tries to extract the client infos out of the received JSON object. If this is not fully
233     * possible, an appropriate message is dumped and the whole message is discarded (the method
234     * return null).
235     * </p>
236     *
237     * @param message the message to parse the client infos from
238     *
239     * @return the client infos, if the message is valid in this respect, or null if not
240     */
241    private HtmlClientInfos extractClientInfos(JSONObject message) {
242        HtmlClientInfos clientInfos = null;
243       
244        JSONObject infos = assertValue(message, "clientInfos", JSONObject.class);
245       
246        if (infos != null) {
247            String clientId = assertValue((JSONObject) infos, "clientId", String.class);
248            String userAgent = assertValue((JSONObject) infos, "userAgent", String.class);
249            URL url = assertValue((JSONObject) infos, "url", URL.class);
250            String title = assertValue((JSONObject) infos, "title", String.class);
251           
252            if (clientId == null) {
253                Console.printerrln("client infos do not contain a valid client id");
254            }
255            else if (userAgent == null) {
256                Console.printerrln("client infos do not contain a valid user agent");
257            }
258            else if (url == null) {
259                Console.printerrln("client infos do not contain a valid URL");
260            }
261            else if (title == null) {
262                Console.printerrln("client infos do not contain a valid title");
263            }
264            else {
265                clientInfos = new HtmlClientInfos(clientId, userAgent, url, title);
266            }
267        }
268       
269        return clientInfos;
270    }
271
272    /**
273     * <p>
274     * tries to extract the events out of the received JSON object. If this is not fully
275     * possible, an appropriate message is dumped and the errorprone event is discarded. If no
276     * valid event is found, the whole message is discarded.
277     * </p>
278     *
279     * @param object      the message to parse the events from
280     * @param clientInfos the infos about the client that send the events
281     * 
282     * @return the valid events stored in the message, or null if there are none
283     */
284    private HtmlEvent[] extractHtmlEvents(JSONObject object, HtmlClientInfos clientInfos) {
285        List<HtmlEvent> events = null;
286       
287        JSONArray eventArray = assertValue(object, "events", JSONArray.class);
288       
289        if (eventArray != null) {
290            events = new ArrayList<HtmlEvent>();
291           
292            HtmlServer server = getServerElement(clientInfos);
293            HtmlDocument document = getPageElementRepresentingWebPage(clientInfos, server);
294
295            for (int i = 0; i < eventArray.size(); i++) {
296                Object eventObj = eventArray.get(i);
297                if (!(eventObj instanceof JSONObject)) {
298                    Console.printerrln("event number " + (i + 1) + " is not a valid event object");
299                }
300                else {
301                    Long time = assertValue(((JSONObject) eventObj), "time", Long.class);
302                    String domPath = assertValue(((JSONObject) eventObj), "path", String.class);
303                    String eventType =
304                        assertValue(((JSONObject) eventObj), "eventType", String.class);
305                    Integer[] coordinates =
306                        assertValue(((JSONObject) eventObj), "coordinates", Integer[].class);
307                    Integer key = assertValue(((JSONObject) eventObj), "key", Integer.class);
308                    Integer[] scrollPosition =
309                        assertValue(((JSONObject) eventObj), "scrollPosition", Integer[].class);
310                    String selectedValue =
311                            assertValue(((JSONObject) eventObj), "selectedValue", String.class);
312                   
313                    if (eventType == null) {
314                        Console.printerrln("event number " + (i + 1) + " has no valid event type");
315                    }
316                    else if (time == null) {
317                        Console.printerrln(eventType + " event has no valid timestamp");
318                    }
319                    else if (domPath == null) {
320                        Console.printerrln(eventType + " event has no valid DOM path");
321                    }
322                    else if ((coordinates != null) && (coordinates.length != 2)) {
323                        Console.printerrln(eventType + " event has no valid coordinates");
324                    }
325                    else if (checkEventParameterCombinations
326                                (eventType, coordinates, key, scrollPosition, selectedValue, domPath))
327                    {
328                        HtmlPageElement target =
329                            guiElementManager.getPageElement(document, domPath);
330                       
331                        if (target != null) {
332                            events.add(new HtmlEvent(clientInfos, time, target, eventType,
333                                                     coordinates, key, scrollPosition,
334                                                     selectedValue));
335                        }
336                        else {
337                            events.add(new HtmlEvent(clientInfos, time, document, domPath,
338                                                     eventType, coordinates, key, scrollPosition,
339                                                     selectedValue));
340                        }
341                    }
342                    else {
343                        Console.printerrln(eventType + " event has no valid parameter combination");
344                    }
345                }
346            }
347           
348        }
349       
350        if ((events != null) && (events.size() > 0)) {
351            return events.toArray(new HtmlEvent[events.size()]);
352        }
353        else {
354            return null;
355        }
356    }
357
358    /**
359     * <p>
360     * extracts the GUI structure from the provided JSON object.
361     * </p>
362     *
363     * @param object      the JSON object to extract the GUI structure from
364     * @param clientInfos infos about the client who send the data
365     *
366     * @return the GUI structure extracted from the JSON object of which the root node is a
367     *         representation of the server of the HTML page that was observed
368     */
369    private HtmlServer extractHtmlPageElements(JSONObject      object,
370                                               HtmlClientInfos clientInfos)
371    {
372        HtmlServer server = getServerElement(clientInfos);
373        HtmlDocument document = getPageElementRepresentingWebPage(clientInfos, server);
374
375        JSONObject jsonPageElement = assertValue(object, "guiModel", JSONObject.class);
376        document.addChild(convert(jsonPageElement, document, null));
377       
378        return server;
379    }
380
381    /**
382     * <p>
383     * instantiates an element of the GUI structure representing the server of the observed
384     * web page
385     * </p>
386     *
387     * @param clientInfos infos about the client who send the data
388     *
389     * @return as described
390     */
391    private HtmlServer getServerElement(HtmlClientInfos clientInfos) {
392        String host = clientInfos.getUrl().getHost();
393        int port = 80;
394       
395        if (clientInfos.getUrl().getPort() > -1) {
396            port = clientInfos.getUrl().getPort();
397        }
398       
399        return guiElementManager.createHtmlServer(host, port);
400    }
401
402    /**
403     * <p>
404     * instantiates an element of the GUI structure representing the observed web page. Adds
405     * this element to the provided server as child.
406     * </p>
407     *
408     * @param clientInfos infos about the client who send the data
409     * @param server      the server on which the page represented by the return value resists
410     *
411     * @return as described
412     */
413    private HtmlDocument getPageElementRepresentingWebPage(HtmlClientInfos clientInfos,
414                                                           HtmlServer      server)
415    {
416        String path = clientInfos.getUrl().getPath();
417        String query = null;
418       
419        if (clientInfos.getUrl().getQuery() != null) {
420            query = "?" + clientInfos.getUrl().getQuery();
421        }
422       
423        HtmlDocument document = guiElementManager.createHtmlDocument
424            (server, path, query, clientInfos.getTitle());
425       
426        server.addChild(document);
427       
428        return document;
429    }
430
431    /**
432     * <p>
433     * converts a JSON object representing an HTML page element to an HTML page element. Calls
434     * itself recursively to also convert the children of the element, if any.
435     * </p>
436     *
437     * @param jsonPageElement the JSON object to be converted
438     * @param document        the document to which the page element belongs
439     * @param parent          the parent page element of the converted element, of null, if none
440     *                        is present. In this case the document is considered the parent
441     *                        element.
442     *                       
443     * @return as described.
444     */
445    private HtmlPageElement convert(JSONObject      jsonPageElement,
446                                    HtmlDocument    document,
447                                    HtmlPageElement parent)
448    {
449        HtmlPageElement result = null;
450
451        if (jsonPageElement != null) {
452            String tagName = assertValue(jsonPageElement, "tagName", String.class);
453            String htmlid = assertValue(jsonPageElement, "htmlId", String.class);
454            Integer index = assertValue(jsonPageElement, "index", Integer.class);
455
456            result = guiElementManager.createHtmlPageElement
457                (document, parent, tagName, htmlid, index);
458
459            JSONArray childElements = assertValue(jsonPageElement, "children", JSONArray.class);
460           
461            if (childElements != null) {
462                Object jsonChild;
463
464                for (int i = 0; i < childElements.size(); i++) {
465                    jsonChild = childElements.get(i);
466                    if (!(jsonChild instanceof JSONObject)) {
467                        Console.printerrln("child " + (i + 1) + " of HTML page element " + tagName +
468                                           " is no valid HTML page element");
469                    }
470                    else {
471                        result.addChild(convert((JSONObject) jsonChild, document, result));
472                    }
473                }
474            }
475           
476        }
477       
478        return result;   
479    }
480
481    /**
482     * <p>
483     * validates if for the given event type the parameter combination of coordinates, key,
484     * scroll position, and selected value is valid. As an example, an onclick event should
485     * usually not have an associated scroll position.
486     * </p>
487     *
488     * @param eventType      the type of the event
489     * @param coordinates    the coordinates of the event
490     * @param key            the key of the event
491     * @param scrollPosition the scroll position of the event
492     * @param selectedValue  the value selected through a specific event
493     * @param domPath            the path through the DOM of the document of the HTML element on which
494     *                       the event was executed
495     *
496     * @return true, if the combination of the parameters is valid, false else
497     */
498    private boolean checkEventParameterCombinations(String    eventType,
499                                                    Integer[] coordinates,
500                                                    Integer   key,
501                                                    Integer[] scrollPosition,
502                                                    String    selectedValue,
503                                                    String    domPath)
504    {
505        boolean result = false;
506       
507        if ("onscroll".equals(eventType)) {
508            result =
509                (coordinates == null) && (key == null) &&
510                (scrollPosition != null) && (selectedValue == null);
511        }
512        else if ("onclick".equals(eventType) || "ondblclick".equals(eventType)) {
513            result =
514                (coordinates != null) && (key == null) &&
515                (scrollPosition == null) && (selectedValue == null);
516        }
517        else if ("onchange".equals(eventType)) {
518            // "input_password" don't have a selectedValue
519            if (domPath.contains("input_password")) {
520                result =
521                    (coordinates == null) && (key == null) &&
522                    (scrollPosition == null) && (selectedValue == null);
523            }
524            else {
525                result =
526                    (coordinates == null) && (key == null) &&
527                    (scrollPosition == null) && (selectedValue != null);
528            }
529
530        }
531        else if ("onkeypress".equals(eventType) || "onkeydown".equals(eventType) ||
532                 "onkeyup".equals(eventType))
533        {
534            result =
535                (coordinates == null) && (key != null) &&
536                (scrollPosition == null) && (selectedValue == null);
537        }
538        else if ("onfocus".equals(eventType) || "onmouseout".equals(eventType) ||
539                 "onmousemove".equals(eventType) || "onload".equals(eventType) ||
540                 "onunload".equals(eventType) || "onbeforeunload".equals(eventType) ||
541                 "onpagehide".equals(eventType) || "onpageshow".equals(eventType) ||
542                 "onabort".equals(eventType) || "onsubmit".equals(eventType) ||
543                 "onplaying".equals(eventType) || "onpause".equals(eventType) ||
544                 "ontimeupdate".equals(eventType) || "onerror".equals(eventType) ||
545                 "onundo".equals(eventType) || "onreset".equals(eventType) ||
546                 "onselect".equals(eventType))
547        {
548            result =
549                (coordinates == null) && (key == null) &&
550                (scrollPosition == null) && (selectedValue == null);
551        }
552        else {
553            Console.printerrln("'" + eventType + "' is not a valid event type");
554        }
555       
556        if (!result) {
557            Console.printerrln(eventType + " event has invalid parameters");
558            Console.printerrln("coordinates: " + coordinates);
559            Console.printerrln("key: " + key);
560            Console.printerrln("scrollPosition: " + scrollPosition);
561            Console.printerrln("selectedValue: " + selectedValue);
562        }
563       
564        return result;
565    }
566
567    /**
568     * <p>
569     * converts a value in the provided object matching the provided key to the provided type. If
570     * there is no value with the key or if the value can not be transformed to the provided type,
571     * the method returns null.
572     * </p>
573     *
574     * @param object the object to read the value from
575     * @param key    the key of the value
576     * @param clazz  the type to which the value should be transformed
577     *
578     * @return the value or null if either the value does not exist or if it can not be transformed
579     *         to the expected type
580     */
581    @SuppressWarnings("unchecked")
582    private <T> T assertValue(JSONObject object, String key, Class<T> clazz) {
583        Object value = object.get(key);
584        T result = null;
585       
586        if (clazz.isInstance(value)) {
587            result = (T) value;
588        }
589        else if (value instanceof String) {
590            if (URL.class.equals(clazz)) {
591                try {
592                    result = (T) new URL((String) value);
593                }
594                catch (MalformedURLException e) {
595                    e.printStackTrace();
596                    Console.printerrln("retrieved malformed URL for key '" + key + "': " + value +
597                                       " (" + e.toString() + ")");
598                }
599            }
600            else if ((int.class.equals(clazz)) || (Integer.class.equals(clazz))) {
601                try {
602                    result = (T) Integer.valueOf(Integer.parseInt((String) value));
603                }
604                catch (NumberFormatException e) {
605                    Console.printerrln
606                        ("retrieved malformed integer for key '" + key + "': " + value);
607                }
608            }
609            else if ((long.class.equals(clazz)) || (Long.class.equals(clazz))) {
610                try {
611                    result = (T) Long.valueOf(Long.parseLong((String) value));
612                }
613                catch (NumberFormatException e) {
614                    Console.printerrln
615                        ("retrieved malformed long for key '" + key + "': " + value);
616                }
617            }
618        }
619        else if (value instanceof Long) {
620            if ((int.class.equals(clazz)) || (Integer.class.equals(clazz))) {
621                result = (T) (Integer) ((Long) value).intValue();
622            }
623        }
624        else if (value instanceof JSONArray) {
625            if ((int[].class.equals(clazz)) || (Integer[].class.equals(clazz))) {
626                Integer[] resultArray = new Integer[((JSONArray) value).size()];
627                boolean allCouldBeParsed = true;
628               
629                for (int i = 0; i < ((JSONArray) value).size(); i++) {
630                    try {
631                        if (((JSONArray) value).get(i) instanceof Long) {
632                            resultArray[i] = (int) (long) (Long) ((JSONArray) value).get(i);
633                        }
634                        else if (((JSONArray) value).get(i) instanceof String) {
635                            try {
636                                resultArray[i] =
637                                    (int) Long.parseLong((String) ((JSONArray) value).get(i));
638                            }
639                            catch (NumberFormatException e) {
640                                Console.printerrln
641                                    ("retrieved malformed integer array for key '" + key + "': " +
642                                     value);
643                       
644                                allCouldBeParsed = false;
645                                break;
646                            }
647                        }
648                        else {
649                            Console.printerrln
650                                ("can not handle type of value in expected integer array '" + key +
651                                 "': " + value);
652                        }
653                    }
654                    catch (ClassCastException e) {
655                        e.printStackTrace();
656                        Console.printerrln("expected integer array for key '" + key +
657                                           "' but it was something else: " + value);
658                       
659                        allCouldBeParsed = false;
660                        break;
661                    }
662                }
663               
664                if (allCouldBeParsed) {
665                    result = (T) resultArray;
666                }
667            }
668        }
669       
670        return result;
671    }
672
673    /**
674     * <p>
675     * Checks whether an agent is a robot.
676     * </p>
677     *
678     * @param agent
679     *            agent that is checked
680     * @return true, if the agent is a robot; false otherwise
681     */
682    private boolean isRobot(String agent) {
683        return agent.matches(robotRegex);
684    }
685
686    /**
687     * <p>
688     * Reads {@link #ROBOTFILTERFILE} and creates a regular expression that
689     * matches all the robots defined in the file. The regular expression is
690     * stored in the field {@link #robotRegex}.
691     * </p>
692     *
693     * @throws IOException
694     *             thrown if there is a problem reading the robot filter
695     * @throws FileNotFoundException
696     *             thrown if the robot filter is not found
697     */
698    private void loadRobotRegex() throws IOException, FileNotFoundException {
699        String[] lines = FileTools.getLinesFromFile(ROBOTFILTERFILE);
700        StringBuilder regex = new StringBuilder();
701        for (int i = 0; i < lines.length; i++) {
702            regex.append("(.*" + lines[i] + ".*)");
703            if (i != lines.length - 1) {
704                regex.append('|');
705            }
706        }
707        robotRegex = regex.toString();
708    }
709
710    /**
711     * <p>
712     * convenience method for dumping the content of a stream and returning a new stream
713     * containing the same data.
714     * </p>
715     *
716     * @param inputStream the stream to be dumped and copied
717     * @return the copy of the stream
718     *
719     * @throws IOException if the stream can not be read
720     */
721/*    private InputStream dumpStreamContent(ServletInputStream inputStream) throws IOException {
722        List<Byte> bytes = new ArrayList<Byte>();
723        int buf;
724       
725        while ((buf = inputStream.read()) >= 0) {
726            bytes.add((byte) buf);
727        }
728       
729        byte[] byteArray = new byte[bytes.size()];
730        for (int i = 0; i < bytes.size(); i++) {
731            byteArray[i] = bytes.get(i);
732        }
733       
734        System.out.println(new String(byteArray, "UTF-8"));
735       
736        return new ByteArrayInputStream(byteArray);
737    }*/
738
739    /**
740     * <p>
741     * convenience method for dumping an object to std out. If the object is a JSON object, it is
742     * deeply analyzed and its internal structure is dumped as well.
743     * </p>
744     *
745     * @param object the object to dump
746     * @param indent the indentation to be used.
747     */
748    private void dumpJSONObject(Object object, String indent) {
749        if (object instanceof JSONArray) {
750            boolean arrayContainsJSONObjects = false;
751            for (Object arrayElem : (JSONArray) object) {
752                if (arrayElem instanceof JSONObject) {
753                    arrayContainsJSONObjects = true;
754                    break;
755                }               
756            }
757           
758            if (arrayContainsJSONObjects) {
759                System.out.println();
760                System.out.print(indent);
761                System.out.println('[');
762                System.out.print(indent);
763                System.out.print(' ');
764            }
765            else {
766                System.out.print(' ');
767                System.out.print('[');
768            }
769           
770            int index = 0;
771            for (Object arrayElem : (JSONArray) object) {
772                if (index++ > 0) {
773                    System.out.print(",");
774                    if (arrayContainsJSONObjects) {
775                        System.out.println();
776                        System.out.print(indent);
777                    }
778
779                    System.out.print(' ');
780                }
781
782                dumpJSONObject(arrayElem, indent + "  ");
783            }
784           
785            if (arrayContainsJSONObjects) {
786                System.out.println();
787                System.out.print(indent);
788            }
789           
790            System.out.print(']');
791        }
792        else if (object instanceof JSONObject) {
793            System.out.println(" {");
794           
795            @SuppressWarnings("unchecked")
796            Set<Map.Entry<?,?>> entrySet = ((JSONObject) object).entrySet();
797           
798            int index = 0;
799            for (Map.Entry<?,?> entry : entrySet) {
800                if (index++ > 0) {
801                    System.out.println(",");
802                }
803                System.out.print(indent);
804                System.out.print("  \"");
805                System.out.print(entry.getKey());
806                System.out.print("\":");
807                dumpJSONObject(entry.getValue(), indent + "  ");
808            }
809           
810            System.out.println();
811            System.out.print(indent);
812            System.out.print('}');
813        }
814        else {
815            System.out.print('"');
816            System.out.print(object);
817            System.out.print('"');
818        }
819    }
820
821}
Note: See TracBrowser for help on using the repository browser.