jscmd 0.0.2 → 0.1.0

data/History.txt

@@ -1,3 +1,11 @@
+= *SVN*
+
+* Refactored everything
+* Now acts as Stomp client
+* Embedded Stomp Server
+* Now works in JRuby (partially, using threads) and mswin32 (using stompserver)
+* Added URLForwarder that adds a bookmarklet that sends the URL of the current page to another browser
+
 = 0.0.2 2007-05-08
 
 * Fixed potential file descriptor leak

data/Manifest.txt

@@ -6,11 +6,19 @@ README.txt
 Rakefile
 bin/jscmd
 lib/jscmd.rb
-lib/jscmd/version.rb
-lib/jscmd/jscommander.rb
 lib/jscmd/asynchttpproxy.rb
+lib/jscmd/inprocessbroker.rb
+lib/jscmd/message.rb
+lib/jscmd/pipebroker.rb
+lib/jscmd/proxyserver.rb
+lib/jscmd/shell.rb
+lib/jscmd/stompproxy.rb
+lib/jscmd/urlforwarder.rb
+lib/jscmd/version.rb
 lib/jscmd/agent.js
 scripts/txt2html
 setup.rb
 test/test_helper.rb
-test/test_jscmd.rb
+test/test_proxyserver.rb
+test/test_shell.rb
+examples/get_title.pl

data/Rakefile

@@ -49,7 +49,7 @@ hoe = Hoe.new(GEM_NAME, VERS) do |p|
   
   # == Optional
   p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
-  #p.extra_deps = []     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  p.extra_deps = [['stomp', '>= 1.0.5'], ['stompserver', '>= 0.9.7']]     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
   #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
 end
 

data/bin/jscmd

@@ -1,4 +1,4 @@
-#! /opt/local/bin/ruby
+#!/usr/bin/env ruby
 
 begin
   require 'rubygems'
@@ -13,32 +13,337 @@ end
 require 'jscmd'
 require 'optparse'
 
-OPTIONS = {
-  :port     => 9000
-}
-MANDATORY_OPTIONS = %w()
-
-parser = OptionParser.new do |opts|
-  opts.banner = <<BANNER
+module JSCommander
+  class CommandLine
+    OPTIONS = {
+      :port => 9000,
+      :bind => "0.0.0.0",
+      :uport => 9001,
+      :ubind => "localhost",
+      :sport => 61613,
+      :sbind => "localhost",
+      :sjournal => ".stompserver",
+      :connect_to => "stomp://localhost:61613/",
+    }
+    MANDATORY_OPTIONS = %w()
+    
+    def initialize
+      
+      parser = OptionParser.new do |opts|
+        opts.banner = <<BANNER
 JS Commander: Remote JavaScript Console
 
 Usage: #{File.basename($0)} [options]
 
+If no options were specified, jscmd starts up Shell and Proxy Server with internal broker.
 Options are:
 BANNER
-  opts.separator ""
-  opts.on("-p", "--port=PORT", Integer,
-          "Start proxy server on the specified port.",
-          "Default: 9000") { |OPTIONS[:port]| }
-  opts.on("-h", "--help",
-          "Show this help message.") { puts opts; exit }
-  opts.parse!(ARGV)
-
-  if MANDATORY_OPTIONS && MANDATORY_OPTIONS.find { |option| OPTIONS[option.to_sym].nil? }
-    puts opts; exit
+        opts.separator ""
+        opts.on("-c", "--console", 
+                "Startup console") { |OPTIONS[:console]| }
+        opts.on("-x", "--proxy", 
+                "Startup proxy server") { |OPTIONS[:proxy]| }
+        opts.on("-p", "--port=PORT", Integer,
+                "Bind proxy server on specified TCP port. (default: 9000)") { |OPTIONS[:port]| }
+        opts.on("-b", "--bind=ADDRESS", String,
+                "Bind proxy server on specified IP address. (default: 0.0.0.0)") { |OPTIONS[:bind]| }
+        opts.on("-u", "--url-forwarder", 
+                "Startup URL forwarder") { |OPTIONS[:url_forwarder]| }
+        opts.on("--uport=PORT", Integer,
+                "Bind URL forwarder on specified TCP port. (default: 9001)") { |OPTIONS[:uport]| }
+        opts.on("--ubind=ADDRESS", String,
+                "Bind URL forwarder on specified IP address. (default: localhost)") { |OPTIONS[:ubind]| }
+        opts.on("-S", "--server",
+                "Startup embedded Stomp server") { |v| OPTIONS[:server] = v || true }
+        opts.on("--sport=PORT", Integer,
+                "Bind Stomp server on specified TCP port. (default: 61613)") { |OPTIONS[:sport]| }
+        opts.on("--sbind=ADDRESS", String,
+                "Bind Stomp server on specified IP address. (default: localhost)") { |OPTIONS[:sbind]| }
+        opts.on("--sjournal=DIR", String,
+                "Specify journal directory of Stomp server. (default: ./.stompserver)") { |OPTIONS[:sjournal]| }
+        opts.on("-C", "--client", String,
+                "Acts as Stomp client.") {|OPTIONS[:client]|}
+        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("--debug-proxy", 
+                "Enable debugging in proxy server.") { |OPTIONS[:debug_proxy]| }
+        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.parse!(ARGV)
+        
+        if MANDATORY_OPTIONS && MANDATORY_OPTIONS.find { |option| OPTIONS[option.to_sym].nil? }
+          puts opts; exit
+        end
+      end
+
+      unless [:console, :proxy, :server, :url_forwarder].any?{|o| OPTIONS[o]}
+        # default is -xc if no processes were specified
+        OPTIONS[:console] = true
+        OPTIONS[:proxy] = true
+        if windows?
+          OPTIONS[:server] = true
+        end
+      end
+#      puts "options: #{encode_options.join(' ')}"
+      
+      @child_pid = nil
+      @threads = []
+      
+      use_stomp = OPTIONS[:server] || OPTIONS[:client]
+      unless never_fork?
+        use_stomp ||= !OPTIONS[:console] || !OPTIONS[:proxy] || OPTIONS[:url_forwarder]
+      end
+      
+      if use_stomp
+        # use stomp broker
+        startup_processes { StompProxy.new(OPTIONS[:connect_to]) }
+      else
+        # use internal broker
+        if !never_fork?
+          r1, w1 = IO.pipe
+          r2, w2 = IO.pipe
+          pid = $$
+          startup_processes do
+            if pid == $$
+              PipeBroker.new(r2, w1)
+            else
+              PipeBroker.new(r1, w2)
+            end
+          end
+        else
+          $stderr.puts "Starting up in multi-threaded mode"
+          # JRuby
+          broker = InProcessBroker.new
+          startup_processes { broker }
+        end
+      end
+    end
+
+    def startup_non_console_processes(&broker_factory)
+      if OPTIONS[:server]
+        t = StompServerLauncher.new
+        t.start
+        @threads << t
+      end
+      if OPTIONS[:proxy]
+        t = ProxyLauncher.new(broker_factory.call)
+        t.start
+        @threads << t
+      end
+      if OPTIONS[:url_forwarder]
+        t = URLForwarderLauncher.new(broker_factory.call)
+        t.start
+        @threads << t
+      end
+    end
+
+    def stop_threads
+      @threads.reverse.each do |t|
+        t.shutdown
+      end
+    end
+
+    def join_threads
+      @threads.reverse.each do |t|
+        t.thread.join
+      end
+    end
+
+    def encode_options
+      options = []
+      OPTIONS.each do |key, value|
+        option = "--#{key.to_s.gsub(/_/, "-")}"
+        case value
+        when true
+          options << option
+        when String, Integer
+          options << "#{option}=#{value}"
+        end
+      end
+      options
+    end
+
+    def startup_processes(&broker_factory)
+      if OPTIONS[:debug_msg]
+        case OPTIONS[:debug_msg]
+        when String
+          $debug_msg_file = open(OPTIONS[:debug_msg], "a")
+        else
+          $debug_msg_file = $stderr
+        end
+        original_factory = broker_factory
+        broker_factory = proc do
+          broker = original_factory.call
+          def broker.send(name, msg)
+            $debug_msg_file.puts "send #{name}, #{msg.inspect}"
+            $debug_msg_file.flush
+            super
+          end
+          broker
+        end
+      end
+      if never_fork?
+        startup_non_console_processes(&broker_factory)
+        run_shell(broker_factory.call)
+        stop_threads
+        join_threads
+      else
+        if OPTIONS[:console]
+          if OPTIONS[:proxy] || OPTIONS[:server] || OPTIONS[:url_forwarder]
+            if windows?
+              require "win32/process"
+              options = encode_options.delete_if{|o|o=="--console"}.map{|o|%("#{o}")}.join(" ")
+              $stderr.puts "Lauching another process with options: #{options}"
+              @win32_process = Process.create(:app_name => "ruby \"#{$0}\" #{options}")
+            else
+              @child_pid = fork do
+                trap("TERM"){stop_threads}
+                trap("INT"){}
+                startup_non_console_processes(&broker_factory)
+                join_threads
+              end
+            end
+          end
+          wait_for_port(OPTIONS[:port]) if OPTIONS[:proxy]
+          wait_for_port(OPTIONS[:sport]) if OPTIONS[:server]
+          run_shell(broker_factory.call)
+        else
+          trap("TERM"){stop_threads}
+          trap("INT"){stop_threads}
+          startup_non_console_processes(&broker_factory)
+          join_threads
+        end
+      end
+    end
+
+    def wait_for_port(port)
+      30.times do
+        begin
+          s = TCPSocket.open("localhost", port)
+          s.close
+          break
+        rescue
+        end
+        sleep 0.3
+      end
+    end
+    
+    def windows?
+      RUBY_PLATFORM =~ /-mswin32$/
+    end
+    
+    def never_fork?
+      "java" == RUBY_PLATFORM || OPTIONS[:never_fork]
+    end
+
+    def run_shell(broker)
+      shell = Shell.new(broker)
+      shell.run
+      if @child_pid
+        Process.kill "TERM", @child_pid
+        Process.waitall
+      elsif @win32_process
+        Process.kill 4, @win32_process.process_id
+        Process.waitpid(@win32_process.process_id)
+      end
+    end
+
+    class ThreadLauncher
+      attr_reader :thread
+      
+      def initialize(broker = nil)
+        @broker = broker
+      end
+      
+      def start
+        @thread = Thread.start do
+          begin
+            run
+          rescue Exception
+            $stderr.puts $!
+            $stderr.puts $!.backtrace
+          end
+        end
+        wait if respond_to?(:wait)
+        @thread
+      end
+
+      def wait_for_port(port)
+        30.times do
+          break unless @thread.alive?
+          begin
+            s = TCPSocket.open("localhost", port)
+            s.close
+            break
+          rescue
+          end
+          sleep 0.3
+        end
+      end
+    end
+
+    class ProxyLauncher < ThreadLauncher
+      def run
+        proxy_options = {:Port => OPTIONS[:port], :BindAddress => OPTIONS[:bind], :AccessLog => [], :ProxyVia => nil}
+        if OPTIONS[:debug_proxy]
+          proxy_options[:Logger] = WEBrick::Log.new(nil, WEBrick::BasicLog::DEBUG)
+        end
+        proxy = ProxyServer.new(@broker, proxy_options)
+        @proxy = proxy
+        proxy.start
+      end
+
+      def wait
+        wait_for_port(OPTIONS[:port])
+      end
+
+      def shutdown
+        @proxy.shutdown
+      end
+    end
+
+    class StompServerLauncher < ThreadLauncher
+      def start
+        require "stomp_server"
+        require "frame_journal"
+        super
+      end
+
+      def run
+        StompServer.setup(FrameJournal.new(OPTIONS[:sjournal]))
+        EventMachine.run do
+          puts "Stomp Server starting on port #{OPTIONS[:sport]}"
+          EventMachine.start_server OPTIONS[:sbind], OPTIONS[:sport], StompServer
+        end
+      end
+
+      def wait
+        wait_for_port(OPTIONS[:sport])
+      end
+
+      def shutdown
+        EventMachine.stop
+      end
+    end
+
+    class URLForwarderLauncher < ThreadLauncher
+      def run
+        @server = URLForwarder.new(@broker,
+                                   :Port => OPTIONS[:uport], 
+                                   :BindAddress => OPTIONS[:ubind])
+        @server.start
+      end
+
+      def shutdown
+        @server.shutdown
+      end
+    end
   end
 end
 
-# do stuff
-server = JSCommander::Broker.new(:Port => OPTIONS[:port], :AccessLog => [], :ProxyVia => nil)
-server.start
+JSCommander::CommandLine.new

data/examples/get_title.pl

@@ -0,0 +1,22 @@
+#!/usr/bin/env perl
+# An example script that prints title of the current page
+use strict;
+use warnings;
+use Net::Stomp;
+
+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"});
+for (;;) {
+    my $frame = $stomp->receive_frame;
+    if ($id eq $frame->headers->{"jscmd.in-reply-to"}) {
+	print $frame->body . "\n";
+	last;
+    }
+} 
+$stomp->disconnect;

data/lib/jscmd/agent.js

@@ -54,36 +54,45 @@
     },
 
     poll: function() {
-        var content = this.queue.length > 0 ? this.queue.shift() : "";
+        var content = this.queue.length > 0 ? this.queue.shift() : {type: "connect", body: ""};
         var xhr = this.createXHR();
         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);
+        if (content.inReplyTo) {
+            xhr.setRequestHeader("X-JSCmd-In-Reply-To", content.inReplyTo);
+        }
         var self = this;
         xhr.onreadystatechange = function() {
             if (xhr.readyState == 4) {
                 delete self.currentXHR;
                 try {
                     if (xhr.status == 200) {
-                        var text = xhr.responseText;
-                        if (text) {
+                        var commandId = xhr.getResponseHeader("X-JSCmd-Command-Id");
+                        var requestType = xhr.getResponseHeader("X-JSCmd-Type");
+                        var script = xhr.responseText;
+                        if (requestType) {
                             var value = null;
+                            var type = null;
                             try {
-                                var option = text.substring(0, 1);
-                                var script = text.substring(1, text.length);
-                                if (option == 'P') {
+                                if (requestType == 'properties') {
                                     // get properties for code completion
                                     var obj = self.evaluate.apply(window, [script, false]);
-                                    value = "V" + self.getAllProperties(obj).join(",");
-                                } else if (option == 'E') {
+                                    value = self.getAllProperties(obj).join(",");
+                                    type = "value";
+                                } else if (requestType == 'eval') {
                                     // just evaluate
-                                    value = "V" + self.evaluate.apply(window, [script, true]);
+                                    value = self.evaluate.apply(window, [script, true]);
+                                    type = "value";
                                 } else {
-                                    value = "Ebad request: " + text;
+                                    value = "bad request: " + script;
+                                    type = "error";
                                 }
                             } catch (e) {
-                                value = "E" + e.toString();
+                                value = e.toString();
+                                type = "error";
                             }
-                            self.queue.push(value);
+                            self.queue.push({inReplyTo: commandId, type: type, body: value});
                         }
                     }
                 } catch (e) {
@@ -102,14 +111,25 @@
         this.currentXHR = xhr;
         if (this.queue.length > 0) {
             // mark that there are more messages pending
-            content = "+" + content;
+            xhr.setRequestHeader("X-JSCmd-More", "true");
+        }
+        xhr.setRequestHeader("X-JSCmd-Type", content.type);
+        xhr.send(encodeURI(content.body));
+    },
+
+    generateAgentId: function() {
+        var chars = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXTZabcdefghiklmnopqrstuvwxyz";
+        var str = "";
+        for (var i = 0; i < 16; i++) {
+            str += chars.charAt(Math.floor(Math.random() * chars.length));
         }
-        xhr.send(encodeURI(content));
+        this.agentId = str;
     },
 
     startPoll: function() {
         this.startPoll = function() {}
         if (window.top.parent != window) return;
+        this.generateAgentId();
         this.poll();
     },
 
@@ -225,10 +245,11 @@
         this.attachEvent("pageshow", function() { self.startPoll() });
 
         window.onerror = function(message, file, line) {
-            self.pushValue("E" + 
-                           "Message: " + message + "\n" +
-                           "File: " + file + "\n" +
-                           "Line: " + line + "\n");
+            self.pushValue({type: "error",
+                            body:
+                            "Message: " + message + "\n" +
+                            "File: " + file + "\n" +
+                            "Line: " + line + "\n"});
         }
         setTimeout(function() { self.startPoll() }, 3000);
         
@@ -243,7 +264,8 @@
                         for (var i = 0; i < arguments.length; i++) {
                             message.push(arguments[i]);
                         }
-                        self.pushValue("V[" + level + "] " + message.join(", "));
+                        self.pushValue({type: "value",
+                                        body:"[" + level + "] " + message.join(", ")});
                     }
                 })();
             }

data/lib/jscmd/asynchttpproxy.rb

@@ -51,7 +51,8 @@ module WEBrick
 
       response = nil
       q = Queue.new
-      p_reader, p_writer = IO.pipe
+      data_queue = Queue.new
+      # p_reader, p_writer = IO.pipe
       thread = Thread.start do
         begin
           @logger.debug "downloading #{uri}"
@@ -87,10 +88,12 @@ module WEBrick
                 if last_size / 500000 != size / 500000
                   @logger.debug "downloading #{uri}: size=#{size}"
                 end
-                p_writer.write str
+                # p_writer.write str
+                data_queue.push str
               end
               @logger.debug "finished downloading #{uri}: size=#{size}"
-              p_writer.close
+              # p_writer.close
+              data_queue.push nil
             end
           }
         rescue Exception => err
@@ -115,7 +118,7 @@ module WEBrick
       choose_header(response, res)
       set_cookie(response, res)
       set_via(res)
-      res.body = p_reader
+      res.body = QueueInput.new(data_queue) # p_reader
       def res.flush_body
         if @body.is_a?(IO)
           begin
@@ -135,6 +138,39 @@ module WEBrick
         handler.call(req, res)
       end
     end
+    
+    class QueueInput < IO
+      def initialize(queue)
+        @queue = queue
+        @eof = false
+      end
+      
+      def close; end
+      
+      def eof?
+        @eof
+      end
+
+      def pop
+        buf = @queue.pop
+        @eof = true if buf.nil?
+        buf
+      end
+
+      def read(len = nil)
+        return nil if eof?
+        if len
+          pop
+        else
+          data = ""
+          while buf = pop
+            data << buf
+          end
+          data
+        end
+      end
+    end
   end
+
 end
 

data/lib/jscmd/inprocessbroker.rb

@@ -0,0 +1,31 @@
+module JSCommander
+  class InProcessBroker
+    def initialize
+      @subscribers = {}
+    end
+
+    def subscribe(name, &block)
+      @subscribers[name] ||= []
+      @subscribers[name] << block
+      block
+    end
+
+    def unsubscribe(name, subscriber)
+      @subscribers[name].delete(subscriber)
+    end
+
+    def send(name, msg)
+      if @subscribers[name]
+        @subscribers[name].each do |sub|
+          Thread.start do
+            begin
+              sub.call(msg)
+            rescue Exception
+              $stderr.puts $!
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jscmd/message.rb

@@ -0,0 +1,42 @@
+=begin
+Messages sent between clients and broker
+
+* Topic "events": proxy -> broker -> shell
+
+Common attributes:
+type - Type of the message. (e.g. "connect")
+clients - List of clients that are connected. (e.g. "[www.google.com],[www.yahoo.com]")
+in-reply-to - id of the command that caused this message (optional; only used with "value", "error" and "pong" types)
+
+Types:
+connect - Notify that the new client has connected. The body must be empty.
+abort - Notify that the client aborted. The body must be empty.
+pong - Reply to "ping" command. body must be empty.
+value - Send value with body.
+error - Send error message with body.
+
+* Topic "commands": shell -> broker -> proxy
+
+Common attributes:
+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.
+eval - Evaluate body.
+properties - Evaluate body and get list of properties.
+
+=end
+module JSCommander
+  class Message
+    attr_accessor :body, :attributes
+    
+    def initialize(body = nil, attributes = {})
+      @body = body
+      @attributes = {}
+      attributes.each do |key, value|
+        @attributes[key.to_s] = value
+      end
+    end
+  end
+end