Changeset 879 for trunk/autoquest-htmlmonitor/src

Timestamp:

10/15/12 14:53:44 (12 years ago)

Author:

pharms

Message:

• changed implementation so that java script is served by server itself and that it determines the servers location through its own URL

Location:

trunk/autoquest-htmlmonitor

Files:

• . (modified) (1 prop)
• src/main/java/de/ugoe/cs/autoquest/htmlmonitor/HtmlMonitorServer.java (modified) (1 diff)
• src/main/java/de/ugoe/cs/autoquest/htmlmonitor/HtmlMonitorServlet.java (modified) (5 diffs)
• src/main/js/autoquest-htmlmonitor.js (modified) (14 diffs)

trunk/autoquest-htmlmonitor/src/main/java/de/ugoe/cs/autoquest/htmlmonitor/HtmlMonitorServer.java

@@ -9 +9 @@
 /**
  * <p>
- * this is the web server, that receives the client messages. It is initialized with a port on
- * which it shall listen, as well as a message listener to forward the received messages to.
- * Internally it starts a jetty web server with a single {@link HtmlMonitorServlet} to receive
- * the messages.
+ * this is the web server, that receives the client messages. It also provides the java script
+ * that is used by the client via the URL /script/autoquest-htmlmonitor.js. It is initialized
+ * with a port on which it shall listen, as well as a message listener to forward the received
+ * messages to. Internally it starts a jetty web server with a single {@link HtmlMonitorServlet}
+ * to receive the messages as well as a .
  * </p>
  * 

trunk/autoquest-htmlmonitor/src/main/java/de/ugoe/cs/autoquest/htmlmonitor/HtmlMonitorServlet.java

@@ -1 +1 @@
 package de.ugoe.cs.autoquest.htmlmonitor;
 
+import java.io.BufferedReader;
 import java.io.IOException;
+import java.io.InputStream;
 import java.io.InputStreamReader;
+import java.io.PrintWriter;
 import java.net.MalformedURLException;
 import java.net.URL;
@@ -24 +27 @@
 /**
  * <p>
- * the servlet deployed in the web server that receives all client messages. The messages are
- * parsed, validated, and forwarded to the provided message listener. If a message is not valid,
- * it is discarded. If an event in a message is not valid, it is discarded. Messages are only
- * received via the POST HTTP method.
+ * the servlet deployed in the web server that receives all client messages and returns the client
+ * java script. The messages are parsed, validated, and forwarded to the provided message listener.
+ * If a message is not valid, it is discarded. If an event in a message is not valid, it is
+ * discarded. Messages are only received via the POST HTTP method. The GET HTTP method is only
+ * implemented for returning the client java script.
  * </p>
  * 
@@ -37 +41 @@
     private static final long serialVersionUID = 1L;
     
+    /**  */
+    private static final boolean DO_TRACE = false;
+    
     /**
      * the message listener to forward received messages to.
@@ -51 +58 @@
     HtmlMonitorServlet(HtmlMonitorMessageListener messageListener) {
         this.messageListener = messageListener;
+    }
+
+    /* (non-Javadoc)
+     * @see org.mortbay.jetty.servlet.DefaultServlet#doGet(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
+     */
+    @Override
+    protected void doGet(HttpServletRequest request, HttpServletResponse response)
+        throws ServletException, IOException
+    {
+        if ((request.getPathInfo() != null) &&
+            (request.getPathInfo().endsWith("/script/autoquest-htmlmonitor.js")))
+        {
+            InputStream script = null;
+            
+            try {
+                script = this.getClass().getClassLoader().getResourceAsStream
+                     ("autoquest-htmlmonitor.js");
+            
+                if (script == null) {
+                    Console.printerrln("could not read autoquest-htmlmonitor.js from classpath");
+                }
+                else {
+                    BufferedReader reader = new BufferedReader(new InputStreamReader(script));
+                    PrintWriter output = response.getWriter();
+                    String line;
+                    
+                    while ((line = reader.readLine()) != null) {
+                        output.println(line);
+                    }
+                    
+                    output.close();
+                }
+            }
+            catch (Exception e) {
+                Console.printerrln("could not read autoquest-htmlmonitor.js from classpath: " + e);
+                Console.logException(e);
+            }
+            finally {
+                if (script != null) {
+                    script.close();
+                }
+            }
+        }
     }
 
@@ -87 +137 @@
      */
     private void handleJSONObject(JSONObject object) {
-        dumpJSONObject(object, "");
+        if (DO_TRACE) {
+            dumpJSONObject(object, "");
+        }
         
         JSONObject message = assertValue(object, "message", JSONObject.class);

trunk/autoquest-htmlmonitor/src/main/js/autoquest-htmlmonitor.js

@@ -25 +25 @@
  * the server to send the recorded data to
  */
-var destination = "http://localhost:8090"; // change to the location of your server
+var autoquestDestination;
 
 /**
  * the maximum number of recorded events to be put into one package sent to the server
  */
-var packageSize = 10;
+var autoquestPackageSize = 10;
 
 /**
@@ -36 +36 @@
  * event handling action to be monitored
  */
-var actionConfig = [
+var autoquestActionConfig = [
     { "tag": "body", "actions": [ "onunload", "onscroll" ] },
     { "tag": "a", "actions": [ "onclick", "ondblclick", "onfocus" ] },
@@ -45 +45 @@
  * a possibility to trace, what is going on
  */
-var doLog = false;
+var autoquestDoLog = false;
 
 /*var matchedTags = ["A", "ABBR", "ACRONYM", "ADDRESS", "AREA", "B", "BIG", "BLOCKQUOTE", "BODY",
@@ -61 +61 @@
  * stores events, which were recorded but not sent to the server yet
  */
-var recordedEvents = [];
+var autoquestRecordedEvents = [];
 
 /**
@@ -77 +77 @@
     if (document.body) {
         log("adding event handling attributes");
+        determineDestination();
         addEventHandlingAttributes(document.documentElement, "");
         
@@ -90 +91 @@
 
 /**
- * traverses the DOM-structure of the HTML-site, and adds event handling attributes to each
+ * traverses the DOM-structure of the HTML-site and determines the URL of this script. Based on
+ * this URL, it calculates the destination to which the traced interactions must be sent
+ */
+function determineDestination() {
+    var scriptElements = document.getElementsByTagName("script");
+    var i;
+    var index;
+    
+    for (i = 0; i < scriptElements.length; i++) {
+        if ((scriptElements[i].type === "text/javascript") && (scriptElements[i].src)) {
+            index = scriptElements[i].src.lastIndexOf("script/autoquest-htmlmonitor.js");
+            if (index > -1) {
+                autoquestDestination = scriptElements[i].src.substring(0, index - 1);
+                log("using destination " + autoquestDestination);
+            }
+        }
+    }
+}
+
+/**
+ * traverses the DOM-structure of the HTML-site and adds event handling attributes to each
  * relevant node
  * 
@@ -105 +126 @@
     
     if (node.nodeType === Node.ELEMENT_NODE) {
-        for (i = 0; i < actionConfig.length; i++) {
-            if (node.tagName.toLowerCase() === actionConfig[i].tag.toLowerCase()) {
-                for (k = 0; k < actionConfig[i].actions.length; k++) {
-                    value = "handleEvent('" + actionConfig[i].actions[k] + "', '" + nodePath +
-                        "', event);";
-
-                    if (!node.getAttribute(actionConfig[i].actions[k])) {
-                        node.setAttribute(actionConfig[i].actions[k], value);
+        for (i = 0; i < autoquestActionConfig.length; i++) {
+            if (node.tagName.toLowerCase() === autoquestActionConfig[i].tag.toLowerCase()) {
+                for (k = 0; k < autoquestActionConfig[i].actions.length; k++) {
+                    value = "handleEvent('" + autoquestActionConfig[i].actions[k] + "', '" +
+                        nodePath + "', event);";
+
+                    if (!node.getAttribute(autoquestActionConfig[i].actions[k])) {
+                        node.setAttribute(autoquestActionConfig[i].actions[k], value);
                     }
                     else {
-                        var oldValue = node.getAttribute(actionConfig[i].actions[k]);
+                        var oldValue = node.getAttribute(autoquestActionConfig[i].actions[k]);
                         if (oldValue.indexOf(value) < 0) {
-                            node.setAttribute(actionConfig[i].actions[k], value + ' ' + oldValue);
+                            node.setAttribute(autoquestActionConfig[i].actions[k],
+                                              value + ' ' + oldValue);
                         }
                     }
@@ -189 +211 @@
  * of the nodes. These attributes are generated by the
  * {@link #addEventHandlingAttributes(node,parentPath)} function. It creates a new Event object and
- * add it to the list of <code>recordedEvents</code>. If this list achieves the maximum
- * <code>packageSize</code> the events in the list are sent to the server asynchronously through
- * calling {@link #sendRequest()}.
+ * add it to the list of <code>autoquestRecordedEvents</code>. If this list achieves the maximum
+ * <code>autoquestPackageSize</code> the events in the list are sent to the server asynchronously
+ * through calling {@link #sendRequest()}.
  * 
  * @param eventName the name of the event, e.g. onscroll
@@ -198 +220 @@
  */
 function handleEvent(eventName, nodePath, event) {
+    log("handling event " + eventName);
+    
+    if (!autoquestDestination) {
+        // do nothing if we have no destination to send data to
+        return;
+    }
+    
     var eventType = eventName.toLowerCase();
     
-    var eventObj = recordedEvents.pop();
+    var eventObj = autoquestRecordedEvents.pop();
     
     // reuse previous on scroll events to prevent too many events
     if ((eventName !== "onscroll") || (!eventObj) || (eventObj.type !== "onscroll")) {
         if (eventObj) {
-            recordedEvents.push(eventObj);
+            autoquestRecordedEvents.push(eventObj);
         }
         eventObj = new Event(eventType, nodePath);
@@ -224 +253 @@
     }
 
-    recordedEvents.push(eventObj);
-
-    if ((recordedEvents.length >= packageSize) || (eventType === "onunload")) {
+    log("storing event " + eventName);
+    autoquestRecordedEvents.push(eventObj);
+
+    if (autoquestRecordedEvents.length >= autoquestPackageSize) {
+        log("initiating sending events");
         setTimeout(sendRequest, 100);
     }
+    else if (eventType === "onunload") {
+        log("initiating sending events");
+        sendRequest();
+    }
 
 }
@@ -234 +269 @@
 /**
  * sends the collected data to the server, named in the destination-variable. For this it generates
- * a JSON formatted message and uses Ajax and the <code>destination</code> to send it to the server
+ * a JSON formatted message and uses Ajax and the <code>autoquestDestination</code> to send it to
+ * the server
  */
 function sendRequest() {
@@ -243 +279 @@
     var request;
     
-    if (recordedEvents.length > 0) {
-        eventList = recordedEvents;
-        recordedEvents = [];
+    if (autoquestRecordedEvents.length > 0) {
+        log("creating message");
+        eventList = autoquestRecordedEvents;
+        autoquestRecordedEvents = [];
         
         message = "{\"message\":{\"clientInfos\":{";
@@ -283 +320 @@
         }
         
-        request.open("POST", destination, true);
+        log("sending message");
+        request.open("POST", autoquestDestination, true);
 
         log("sending " + message);
@@ -434 +472 @@
  */
 function log(text) {
-    if (doLog) {
+    if (autoquestDoLog) {
         var loggingInfo = document.getElementById("loggingInfoParagraph");