tobias-rack-webconsole 0.1.4

data/lib/rack/webconsole/railtie.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+module Rack
+  class Webconsole
+    # Railtie loaded in Rails applications. Its purpose is to automatically use
+    # the middleware in development environment, so that Rails users only have
+    # to require 'rack-webconsole' in their Gemfile and nothing more than that.
+    #
+    class Railtie < Rails::Railtie
+      initializer 'rack-webconsole.add_middleware' do |app|
+        app.middleware.use Rack::Webconsole if Rails.env.development?
+      end
+    end
+  end
+end

data/lib/rack/webconsole/repl.rb

@@ -0,0 +1,86 @@
+# encoding: utf-8
+require 'multi_json'
+require 'digest/sha1'
+
+module Rack
+  class Webconsole
+    # {Repl} is a Rack middleware acting as a Ruby evaluator application.
+    #
+    # In a nutshell, it evaluates a string in a {Sandbox} instance stored in an
+    # evil global variable. Then, to keep the state, it inspects the local
+    # variables and stores them in an instance variable for further retrieval.
+    #
+    class Repl
+      @@request = nil
+      @@token   = nil
+
+      class << self
+        # Returns the autogenerated security token
+        #
+        # @return [String] the autogenerated token
+        def token
+          @@token
+        end
+
+        # Regenerates the token.
+        def reset_token
+          @@token = Digest::SHA1.hexdigest("#{rand(36**8)}#{Time.now}")[4..20]
+        end
+
+        # Returns the original request for inspection purposes.
+        #
+        # @return [Rack::Request] the original request
+        def request
+          @@request
+        end
+
+        # Sets the original request for inspection purposes.
+        #
+        # @param [Rack::Request] the original request
+        def request=(request)
+          @@request = request
+        end
+      end
+
+      # Honor the Rack contract by saving the passed Rack application in an ivar.
+      #
+      # @param [Rack::Application] app the previous Rack application in the
+      #   middleware chain.
+      def initialize(app)
+        @app = app
+      end
+
+      # Evaluates a string as Ruby code and returns the evaluated result as
+      # JSON.
+      #
+      # It also stores the {Sandbox} state in a `$sandbox` global variable, with
+      # its local variables.
+      #
+      # @param [Hash] env the Rack request environment.
+      # @return [Array] a Rack response with status code 200, HTTP headers
+      #   and the evaluated Ruby result.
+      def call(env)
+        status, headers, response = @app.call(env)
+
+        req = Rack::Request.new(env)
+        params = req.params
+
+        return [status, headers, response] unless check_legitimate(req)
+
+        $sandbox ||= Sandbox.new
+        hash = Shell.eval_query params['query']
+        response_body = MultiJson.encode(hash)
+        headers = {}
+        headers['Content-Type'] = 'application/json'
+        headers['Content-Length'] = response_body.bytesize.to_s
+        [200, headers, [response_body]]
+      end
+
+      private
+
+      def check_legitimate(req)
+        req.post? && !Repl.token.nil? && req.params['token'] == Repl.token
+      end
+    end
+  end
+end

data/lib/rack/webconsole/sandbox.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+module Rack
+  class Webconsole
+    # A sandbox to evaluate Ruby in. It is responsible for retrieving local
+    # variables stored in `@locals`, and resetting the environment.
+    #
+    class Sandbox
+      # Catches all the undefined local variables and tries to retrieve them
+      # from `@locals`. If it doesn't find them, it falls back to the default
+      # method missing behavior.
+      def method_missing(method, *args, &block)
+        @locals ||= {}
+        @locals[method.to_sym] || super(method, *args, &block)
+      end
+
+      # Makes the console use a fresh, new {Sandbox} with all local variables
+      # resetted.
+      #
+      # @return [String] 'ok' to make the user notice.
+      def reload!
+        $sandbox = Sandbox.new
+        'ok'
+      end
+
+      # Returns the current page request object for inspection purposes.
+      #
+      # @return [Rack::Request] the current page request object.
+      def request
+        Webconsole::Repl.request
+      end
+    end
+  end
+end

data/lib/rack/webconsole/shell.rb

@@ -0,0 +1,74 @@
+require 'ripl'
+
+class Rack::Webconsole
+  module Shell
+    def self.eval_query(query)
+      # Initialize ripl plugins
+      @before_loop_called ||= Ripl.shell.before_loop
+
+      Ripl.shell.input = query
+      Ripl.shell.loop_once
+      {}.tap do |hash|
+        hash[:result] = Ripl.shell.return_result
+        hash[:multi_line] = Ripl.shell.multi_line?
+        hash[:previous_multi_line] = Ripl.shell.previous_multi_line?
+        hash[:prompt] = Ripl.shell.previous_multi_line? ?
+          Ripl.config[:multi_line_prompt] : Ripl.config[:prompt]
+      end
+    end
+
+    # TODO: move to plugin
+    def multi_line?
+      @buffer.is_a?(Array)
+    end
+
+    def previous_multi_line?
+      @old_buffer.is_a?(Array)
+    end
+
+    def get_input
+      @old_buffer = @buffer
+      history << @input
+      @input
+    end
+
+    def loop_eval(query)
+      # Force conversion to symbols due to issues with lovely 1.8.7
+      boilerplate = local_variables.map(&:to_sym) + [:ls, :result]
+
+      $sandbox.instance_eval """
+        result = (#{query})
+        ls = (local_variables.map(&:to_sym) - [#{boilerplate.map(&:inspect).join(', ')}])
+        @locals ||= {}
+        @locals.update(ls.inject({}) do |hash, value|
+          hash.update({value => eval(value.to_s)})
+        end)
+        result
+      """
+    end
+
+    def print_eval_error(err)
+      @result = "Error: " + err.message
+    end
+
+    def return_result
+      @error_raised ? result : result.inspect
+    end
+
+    def print_result(result) end
+  end
+end
+
+# Disable readline's #get_input
+Ripl.config[:readline] = false
+Ripl.config[:multi_line_prompt] = '|| '
+Ripl.config[:prompt] = '>> '
+Ripl.config[:irbrc] = false
+# Let ripl users detect web shells
+Ripl.config[:web] = true
+
+Ripl::Shell.include Rack::Webconsole::Shell
+# must come after Webconsole plugin
+require 'ripl/multi_line'
+
+at_exit { Ripl.shell.after_loop }

data/lib/rack/webconsole/version.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+module Rack
+  class Webconsole
+    # rack-webconsole version number.
+    VERSION = "0.1.4"
+  end
+end

data/public/jquery.html

@@ -0,0 +1 @@
+<script type="text/javascript" src="http://code.jquery.com/jquery-1.6.2.min.js"></script>

data/public/webconsole.css

@@ -0,0 +1,86 @@
+#rack-webconsole {
+  opacity: 0.9;
+  z-index: 999;
+  background: #000;
+  color: #DDD;
+  font-family: monospace;
+  height: 40%;
+  position: fixed;
+  width: 100%;
+  bottom: 0px;
+  left: 0px;
+  right:0px;
+  outline-top: 3px solid #DEDEDE;
+  box-shadow: 0px -4px 5px rgba(0,0,0,0.5);
+  -moz-box-shadow: 0px -4px 5px rgba(0,0,0,0.5);
+  -webkit-box-shadow: 0px -4px 5px rgba(0,0,0,0.5);
+  font-size: 11px;
+}
+#rack-webconsole div.query{
+  margin-top: 10px;
+  font-weight: bold;
+  padding-top: 10px;
+  border-top: 1px dashed #333;
+  margin-bottom: 5px;
+}
+#rack-webconsole div.query_multiline{
+  font-weight: bold;
+  margin-bottom: 5px;
+}
+#rack-webconsole div.query:first-child{
+  margin-top: 0px;
+  padding-top: 0px;
+  border-top: none;
+}
+#rack-webconsole div.result{
+  font-weight: normal;
+}
+#rack-webconsole form div, #console form span {
+  font-size: 14px;
+  border: 0px;
+  font-family: monospace;
+  color: #FFF;
+}
+#rack-webconsole form div.results_wrapper{
+  width: 100%;
+  position: absolute;
+  overflow-x: auto;
+  top: 0;
+  bottom: 40px;
+}
+#rack-webconsole form div.results{
+  padding: 10px;
+}
+#rack-webconsole .prompt{
+  width: 30px;
+  text-align: center;
+  display: block;
+  float: left;
+  height: 25px;
+  line-height: 25px;
+}
+#rack-webconsole form div.input{
+  width: 100%;
+  position: absolute;
+  bottom: 0px;
+  background: #000;
+}
+#rack-webconsole form div.input input{
+  -webkit-box-sizing: border-box;
+  -moz-box-sizing: border-box;
+  box-sizing: border-box;
+  margin-top: 0px;
+  margin-bottom: 0px;
+  padding: 0px;
+  width: 100%;
+  font-size: 14px;
+  background: transparent;
+  border: 0px;
+  font-family: monospace;
+  color: #FFF;
+}
+#rack-webconsole .input .input_box{
+  margin-left: 30px;
+  margin-right: 10px;
+  display: block;
+}

data/public/webconsole.html

@@ -0,0 +1,15 @@
+<div id="rack-webconsole" style="display:none">
+  <form accept-charset="UTF-8" action="/webconsole" method="post">
+    <input name="utf8" type="hidden" value="✓"/>
+    <div class="results_wrapper">
+      <div class="results">
+      </div>
+    </div>
+    <div class="input">
+      <span class="prompt">>></span>
+      <span class="input_box">
+        <input id="webconsole_query" name="webconsole_query" type="text" />
+      </span>
+    </div>
+  </form>
+</div>

data/public/webconsole.js

@@ -0,0 +1,92 @@
+(function($) {
+  
+  var webconsole = {
+    history:[],
+    pointer:0,
+    query:$('#webconsole_query')
+  }
+  
+  $('#rack-webconsole form').submit(function(e){
+    e.preventDefault();
+  });
+
+  $("#rack-webconsole form input").keyup(function(event) {
+    function escapeHTML(string) {
+      return(string.replace(/&/g,'&').
+        replace(/>/g,'>').
+        replace(/</g,'&lt;').
+        replace(/"/g,'&quot;')
+      );
+    };
+
+    // enter
+    if (event.which == 13) {
+      webconsole.history.push(webconsole.query.val());
+      webconsole.pointer = webconsole.history.length - 1;
+      $.ajax({
+        url: '$CONTEXT/webconsole',
+        type: 'POST',
+        dataType: 'json',
+        data: ({query: webconsole.query.val(), token: "$TOKEN"}),
+        success: function (data) {
+          var query_class = data.previous_multi_line ? 'query_multiline' : 'query';
+          var result = "<div class='" + query_class + "'>" +
+            escapeHTML(data.prompt + webconsole.query.val()) + "</div>";
+          if (!data.multi_line) {
+            result += "<div class='result'>" + escapeHTML("=> " + data.result) + "</div>";
+          }
+          $("#rack-webconsole .results").append(result);
+          $("#rack-webconsole .results_wrapper").scrollTop(
+            $("#rack-webconsole .results").height()
+          );
+          webconsole.query.val('');
+        }
+      });
+    }
+    
+    // up
+    if (event.which == 38) {
+      if (webconsole.pointer < 0) {
+        webconsole.query.val('');
+      } else {
+        if (webconsole.pointer == webconsole.history.length) {
+          webconsole.pointer = webconsole.history.length - 1;
+        }
+        webconsole.query.val(webconsole.history[webconsole.pointer]);
+        webconsole.pointer--;
+      }
+    }
+    
+    // down
+    if (event.which == 40) {
+      if (webconsole.pointer == webconsole.history.length) {
+        webconsole.query.val('');
+      } else {
+        if (webconsole.pointer < 0) {
+          webconsole.pointer = 0;
+        }
+        webconsole.query.val(webconsole.history[webconsole.pointer]);
+        webconsole.pointer++;
+      }
+    }
+    
+  });
+
+  $(document).ready(function() {
+    $(this).keypress(function(event) {
+      if (event.which == $KEY_CODE) {
+        $("#rack-webconsole").slideToggle('fast', function() {
+          if ($(this).is(':visible')) {
+            $("#rack-webconsole form input").focus();
+            $("#rack-webconsole .results_wrapper").scrollTop(
+              $("#rack-webconsole .results").height()
+            );
+          } else {
+            $("#rack-webconsole form input").blur();
+          }
+        });
+        event.preventDefault();
+      }
+    });
+  });
+})(jQuery);

data/rack-webconsole.gemspec

@@ -0,0 +1,36 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rack/webconsole/version"
+
+Gem::Specification.new do |s|
+  s.name        = "tobias-rack-webconsole"
+  s.version     = Rack::Webconsole::VERSION
+  s.authors     = ["Josep M. Bach", "Josep Jaume Rey", "Oriol Gual"]
+  s.email       = ["toby@tcrawley.org"]
+  s.homepage    = "http://github.com/tobias/rack-webconsole"
+  s.summary     = %q{Rack-based console inside your web applications - this is a fork of http://github.com/codegram/rack-webconsole}
+  s.description = s.summary
+
+  s.rubyforge_project = "rack-webconsole"
+
+  s.add_runtime_dependency 'rack'
+  s.add_runtime_dependency 'multi_json', '~> 1.0.3'
+  s.add_runtime_dependency 'ripl', '~> 0.5.1'
+  s.add_runtime_dependency 'ripl-multi_line', '~> 0.3.0'
+
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'purdytest'
+
+  # Since we can't have a git dependency in gemspec, we specify this
+  # dependency directly in the Gemfile. Once a new mocha version is released,
+  # we should uncomment this line and remove mocha from the Gemfile.
+  # s.add_development_dependency 'mocha'
+
+  s.add_development_dependency 'yard'
+  s.add_development_dependency 'bluecloth'
+  s.add_development_dependency 'rake'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ["lib"]
+end