jscmd 0.1.0 → 0.2.0

data/History.txt

@@ -1,5 +1,15 @@
 = *SVN*
 
+= 0.2.0 2007-10-08
+
+* Console API now works in Safari.
+* Let polling time out after 15 seconds. (Can be configured with --reconnect-interval option)
+* Fixed crashes when there are many commands sent from browser at once.
+* Added --disable-proxy-injection option to turn off the debugging ability of proxy server.
+* Added --trace-proxy-request option to trace the request and response sent to/from the proxy server.
+
+= 0.1.0 2007-05-13
+
 * Refactored everything
 * Now acts as Stomp client
 * Embedded Stomp Server

data/bin/jscmd

@@ -24,6 +24,7 @@ module JSCommander
       :sbind => "localhost",
       :sjournal => ".stompserver",
       :connect_to => "stomp://localhost:61613/",
+      :reconnect_interval => 15
     }
     MANDATORY_OPTIONS = %w()
     
@@ -66,14 +67,21 @@ BANNER
         opts.on("--connect-to=URL", String,
                 "Specify URL of Stomp server in stomp://[user:pass@]host:port/ format.",
                 "(default: stomp://localhost:61613/)") { |OPTIONS[:connect_to]| }
+         opts.on("--reconnect-interval=SECONDS", Integer,
+                 "Configure polling timeout of the proxy server. (default: 15)") { |OPTIONS[:reconnect_interval]| }
+        opts.on("--disable-proxy-injection", 
+                "Disable proxy injection and act as a plain proxy server.") { |OPTIONS[:disable_proxy_injection]| }
         opts.on("--debug-proxy", 
                 "Enable debugging in proxy server.") { |OPTIONS[:debug_proxy]| }
+        opts.on("--trace-proxy-request", 
+                "Trace HTTP requests sent to proxy server.") { |OPTIONS[:trace_proxy_request]| }
         opts.on("--debug-msg=[LOGFILE]", 
                 "Print messages that are being sent.") { |OPTIONS[:debug_msg]| }
         opts.on("--never-fork", 
                 "Never fork - use threads only (experimental).") { |OPTIONS[:never_fork]| }
         opts.on("-h", "--help",
                 "Show this help message.") { puts opts; exit }
+        opts.version = Jscmd::VERSION::STRING
         opts.parse!(ARGV)
         
         if MANDATORY_OPTIONS && MANDATORY_OPTIONS.find { |option| OPTIONS[option.to_sym].nil? }
@@ -289,10 +297,20 @@ BANNER
 
     class ProxyLauncher < ThreadLauncher
       def run
-        proxy_options = {:Port => OPTIONS[:port], :BindAddress => OPTIONS[:bind], :AccessLog => [], :ProxyVia => nil}
+        proxy_options = {
+          :Port => OPTIONS[:port], 
+          :BindAddress => OPTIONS[:bind], 
+          :AccessLog => [], 
+          :ProxyVia => nil,
+          :disable_proxy_injection => OPTIONS[:disable_proxy_injection],
+          :reconnect_interval => OPTIONS[:reconnect_interval]
+        }
         if OPTIONS[:debug_proxy]
           proxy_options[:Logger] = WEBrick::Log.new(nil, WEBrick::BasicLog::DEBUG)
         end
+        if OPTIONS[:trace_proxy_request]
+          proxy_options[:trace_request] = true
+        end
         proxy = ProxyServer.new(@broker, proxy_options)
         @proxy = proxy
         proxy.start

data/examples/get_title.pl

@@ -8,15 +8,15 @@ my $stomp = Net::Stomp->new({hostname => 'localhost', port => '61613'});
 $stomp->connect({login => '', passcode => ''});
 $stomp->subscribe({destination => "/topic/events"});
 my $id = rand();
-$stomp->send({destination => "/topic/commands", 
-	      "jscmd.type" => "eval", 
-	      "jscmd.id" => $id, 
-	      body => "document.title"});
+$stomp->send({destination => "/topic/commands",
+              "jscmd.type" => "eval",
+              "jscmd.id" => $id,
+              body => "document.title"});
 for (;;) {
     my $frame = $stomp->receive_frame;
     if ($id eq $frame->headers->{"jscmd.in-reply-to"}) {
-	print $frame->body . "\n";
-	last;
+        print $frame->body . "\n";
+        last;
     }
-} 
+}
 $stomp->disconnect;

data/lib/jscmd.rb

@@ -1,5 +1,7 @@
 # Dir[File.join(File.dirname(__FILE__), 'jscmd/**/*.rb')].sort.each { |lib| require lib }
 
+require "jscmd/version"
+
 # message
 require "jscmd/message"
 
@@ -12,3 +14,4 @@ require "jscmd/stompproxy"
 require "jscmd/proxyserver"
 require "jscmd/shell"
 require "jscmd/urlforwarder"
+

data/lib/jscmd/agent.js

@@ -53,9 +53,32 @@
         return value;
     },
 
-    poll: function() {
-        var content = this.queue.length > 0 ? this.queue.shift() : {type: "connect", body: ""};
+    send: function() {
+        if (this.queue.length == 0) return;
+        var self = this;
+        this.request("send", {
+                content: function() { return self.queue.shift() },
+                setup: function(xhr) { xhr.setRequestHeader("X-JSCmd-More", "true"); },
+                nextRequest: function() { self.send() }
+            });
+    },
+
+    receive: function() {
+        var self = this;
+        this.request("receive", {
+                content: function() { return self.queue.length > 0 ? self.queue.shift() : {type: "connect", body: ""}},
+                setup: function(xhr) {},
+                nextRequest: function() { self.receive() }
+            });
+    },
+
+    request: function(name, handler) {
+        if (this.currentXHR[name]) return;
+        if (this.aborted) return;
+        var content = handler.content();
+        if (!content) return;
         var xhr = this.createXHR();
+        this.currentXHR[name] = xhr;
         xhr.open("POST", "/_remote_js_proxy/poll", true);
         xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
         xhr.setRequestHeader("X-JSCmd-Agent-Id", this.agentId);
@@ -65,7 +88,7 @@
         var self = this;
         xhr.onreadystatechange = function() {
             if (xhr.readyState == 4) {
-                delete self.currentXHR;
+                self.currentXHR[name] = null;
                 try {
                     if (xhr.status == 200) {
                         var commandId = xhr.getResponseHeader("X-JSCmd-Command-Id");
@@ -84,6 +107,7 @@
                                     // just evaluate
                                     value = self.evaluate.apply(window, [script, true]);
                                     type = "value";
+                                } else if (requestType == 'nop') {
                                 } else {
                                     value = "bad request: " + script;
                                     type = "error";
@@ -92,27 +116,30 @@
                                 value = e.toString();
                                 type = "error";
                             }
-                            self.queue.push({inReplyTo: commandId, type: type, body: value});
+                            if (type) {
+                                self.queue.push({inReplyTo: commandId, type: type, body: value});
+                            }
                         }
+                    } else {
+                        setTimeout(handler.nextRequest, 5000);
+                        return;
                     }
                 } catch (e) {
-                    // failed to poll; ignore
+                    setTimeout(handler.nextRequest, 5000);
+                    return;
                 }
                 if (!self.aborted) {
-                    if (self.queue.length > 0) {
-                        self.poll();
-                    } else {
-                        // if polling failed, try again later
-                        setTimeout(function() { self.poll() }, 5000);
-                    }
+                    setTimeout(handler.nextRequest, 0);
                 }
             }
         }
-        this.currentXHR = xhr;
+        handler.setup(xhr);
+        /*
         if (this.queue.length > 0) {
             // mark that there are more messages pending
             xhr.setRequestHeader("X-JSCmd-More", "true");
         }
+        */
         xhr.setRequestHeader("X-JSCmd-Type", content.type);
         xhr.send(encodeURI(content.body));
     },
@@ -130,23 +157,21 @@
         this.startPoll = function() {}
         if (window.top.parent != window) return;
         this.generateAgentId();
-        this.poll();
+        this.receive();
+        var self = this;
+        setInterval(function() { self.receive() }, 5000);
     },
 
-    abortPoll: function(retry) {
-        if (!retry) {
-            // don't retry any more
-            this.aborted = true;
-        }
-        if (this.currentXHR) {
-            this.currentXHR.abort();
+    abortPoll: function() {
+        this.aborted = true;
+        if (this.currentXHR["receive"]) {
+            this.currentXHR["receive"].abort();
         }
     },
 
     pushValue: function(value) {
         this.queue.push(value);
-        this.abortPoll(true);
-        this.startPoll(); // in case startPoll has not been called yet
+        this.send();
     },
 
     attachEvent: function(event, handler) {
@@ -253,7 +278,7 @@
         }
         setTimeout(function() { self.startPoll() }, 3000);
         
-        if (!window.console) {
+        //if (!window.console) {
             window.console = {};
             var levels = ["debug", "info", "warn", "error"];
             for (var i = 0; i < levels.length; i++) {
@@ -270,6 +295,8 @@
                 })();
             }
             window.console.log = window.console.info;
-        }
-    }
+        //}
+    },
+    
+    currentXHR: {}
 }).init();

data/lib/jscmd/message.rb

@@ -22,7 +22,8 @@ type - Type of the message. (e.g. "eval")
 id - unique value that identifies this command. (optional; only used with "eval" and "properties" types)
 
 Types:
-ping - Request "update_clients". The body must be empty.
+ping - Request the status of clients from shell to proxy server. It will not be routed to web browser. The body must be empty.
+nop - Empty message sent from proxy server to web browser when there were no commands within reconnect_interval seconds.
 eval - Evaluate body.
 properties - Evaluate body and get list of properties.
 

data/lib/jscmd/proxyserver.rb

@@ -27,15 +27,18 @@ end
 module JSCommander
   class ProxyServer < WEBrick::AsyncHTTPProxyServer
     SCRIPT_DIR = "/_remote_js_proxy/"
+    attr_reader :reconnect_interval
     
     class CommandDispatcher
       class CLIENT_ABORTED < StandardError; end
       class SHUTDOWN < StandardError; end
       
       def initialize(server, command_queue)
+        @server = server
         @client_mutex = Mutex.new
         @client_ready = ConditionVariable.new
         @clients = []
+        @last_clients = nil
         @thread = Thread.start do
           while server.status != :Shutdown
             command = command_queue.pop
@@ -55,12 +58,16 @@ module JSCommander
         end
       end
 
+      def last_clients
+        @last_clients
+      end
+
       def format_clients
-        @clients.map{|c|"[#{c.hostname}]"}.join(",")
+        @last_clients = @clients.map{|c|"[#{c.hostname}]"}.join(",")
       end
 
       def new_client(req, &block)
-        client = Client.new(req)
+        client = Client.new(req, @server.reconnect_interval)
         @client_mutex.synchronize do
           @clients << client
           @client_ready.signal
@@ -75,14 +82,25 @@ module JSCommander
       end
 
       class Client
-        def initialize(req)
+        def initialize(req, reconnect_interval)
           @request = req
           @queue = Queue.new
+          @pop_time = nil
           req_socket = req.instance_eval{@socket}
           @thread = Thread.start do
             sleep 1 until req_socket.eof?
             @queue.push CLIENT_ABORTED
           end
+          @reconnect_thread = Thread.start do
+            loop do
+              if @pop_time && Time.now >= @pop_time + reconnect_interval
+                @pop_time = nil
+                @queue.push Message.new(nil, :type => "nop")
+                break
+              end
+              sleep 1
+            end
+          end
         end
 
         def hostname
@@ -98,12 +116,19 @@ module JSCommander
           @queue.push(command)
         end
         
+        def abort
+          @thread.kill
+        end
+
         def pop_command
+          @pop_time = Time.now
           r = @queue.pop
+          @pop_time = nil
           # thread is automatically stopped if r == CLIENT_ABORTED
           if r != CLIENT_ABORTED
             @thread.kill
           end
+          @reconnect_thread.kill
           r
         end
       end
@@ -124,7 +149,17 @@ module JSCommander
         end
       end
       @clients = []
-      super({:ProxyContentHandler => method(:handle_content).to_proc}.merge(args))
+      options = args[:disable_proxy_injection] ? args : {:ProxyContentHandler => method(:handle_content).to_proc}.merge(args)
+      @trace_request = args[:trace_request]
+      @requests = 0
+      @reconnect_interval = args[:reconnect_interval]
+      super(options)
+    end
+
+    def trace(msg)
+      if @trace_request
+        $stderr.puts "[TRACE] " + msg
+      end
     end
 
     def service(req, res)
@@ -145,6 +180,19 @@ module JSCommander
       end
     end
 
+    alias_method :do_service, :service
+    
+    def service(req, res)
+      @requests += 1
+      trace(">" * @requests + " #{req.unparsed_uri}")
+      begin
+        do_service(req, res)
+      ensure
+        trace("<" * @requests + " #{req.unparsed_uri}")
+        @requests -= 1
+      end
+    end
+
     def shutdown
       @command_dispatcher.shutdown
       super
@@ -156,7 +204,7 @@ module JSCommander
         @command_dispatcher.new_client(req) do |client|
           type = req.header["x-jscmd-type"].first
           if type && type != "connect"
-            @broker.send("events", Message.new(URI.decode(req.body), 
+            @broker.send("events", Message.new(URI.decode(req.body || ""), 
                                                :type => type,
                                                :clients => @command_dispatcher.format_clients,
                                                "in-reply-to" => req.header["x-jscmd-in-reply-to"].first))
@@ -164,12 +212,15 @@ module JSCommander
               # immediately send empty response to wait for another event
               res.content_type = "text/plain"
               res.body = ''
+              client.abort
               return
             end
           else
             # new connection
-            @broker.send("events", Message.new(nil, :type => "connect",
-                                               :clients => @command_dispatcher.format_clients))
+            if @command_dispatcher.last_clients != @command_dispatcher.format_clients
+              @broker.send("events", Message.new(nil, :type => "connect",
+                                                 :clients => @command_dispatcher.format_clients))
+            end
           end
           
           command = client.pop_command

data/lib/jscmd/shell.rb

@@ -81,6 +81,9 @@ module JSCommander
       @clients = nil
       @msg_lock = Mutex.new
       @wait_for_event = {}
+      @interrupt_lock = Mutex.new
+      @interrupt_ready_cv = ConditionVariable.new
+      @interrupt_ready = false
     end
 
     def generate_id
@@ -161,6 +164,10 @@ module JSCommander
           when "connect"
             puts
           end
+          @interrupt_lock.synchronize do
+            @interrupt_ready_cv.wait(@interrupt_lock) until @interrupt_ready
+            @interrupt_ready = false
+          end
           if Process.methods.include?("kill")
             Process.kill "INT", $$  # interrupt readline
           else
@@ -169,8 +176,12 @@ module JSCommander
           end
         end
       end
-      
+
       begin
+        @interrupt_lock.synchronize do
+          @interrupt_ready = true
+          @interrupt_ready_cv.broadcast
+        end
         loop do
           break unless line = console.readline
           if line.chomp == ''

data/lib/jscmd/version.rb

@@ -1,7 +1,7 @@
 module Jscmd #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
-    MINOR = 1
+    MINOR = 2
     TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join('.')

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.2
 specification_version: 1
 name: jscmd
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
-date: 2007-05-13 00:00:00 +09:00
+  version: 0.2.0
+date: 2007-10-08 00:00:00 +09:00
 summary: JavaScript console for any browser
 require_paths: 
 - lib
@@ -57,10 +57,13 @@ test_files:
 - test/test_helper.rb
 - test/test_proxyserver.rb
 - test/test_shell.rb
-rdoc_options: []
-
-extra_rdoc_files: []
-
+rdoc_options: 
+- --main
+- README.txt
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
 executables: 
 - jscmd
 extensions: []