rack-bug 0.2.1

data/lib/rack/bug/panels/sql_panel/query.rb

@@ -0,0 +1,73 @@
+module Rack
+  module Bug
+    class SQLPanel
+      
+      class Query
+        attr_reader :sql
+        attr_reader :time
+        attr_reader :backtrace
+        
+        def initialize(sql, time, backtrace = [])
+          @sql = sql
+          @time = time
+          @backtrace = backtrace
+        end
+        
+        def human_time
+          "%.2fms" % (@time * 1_000)
+        end
+
+        def inspectable?
+          sql.strip =~ /^SELECT /i
+        end
+        
+        def with_profiling
+          self.class.execute("SET PROFILING=1")
+          result = yield
+          self.class.execute("SET PROFILING=0")
+          return result
+        end
+        
+        def explain
+          self.class.execute "EXPLAIN #{@sql}"
+        end
+        
+        def profile
+          with_profiling do
+            execute
+            self.class.execute <<-SQL
+              SELECT *
+                FROM information_schema.profiling
+               WHERE query_id = (SELECT query_id FROM information_schema.profiling ORDER BY query_id DESC LIMIT 1)
+            SQL
+          end
+        end
+        
+        def execute
+          self.class.execute(@sql)
+        end
+        
+        def valid_hash?(secret_key, possible_hash)
+          hash = Digest::SHA1.hexdigest [secret_key, @sql].join(":")
+          possible_hash == hash
+        end
+        
+        def self.execute(sql)
+          ActiveRecord::Base.connection.execute(sql)
+        end
+        
+        def has_backtrace?
+          filtered_backtrace.any?
+        end
+        
+        def filtered_backtrace
+          @filtered_backtrace ||= @backtrace.map { |l| l.to_s.strip }.select do |line|
+            line.starts_with?(Rails.root) &&
+            !line.starts_with?(Rails.root.join("vendor"))
+          end
+        end
+      end
+      
+    end
+  end
+end

data/lib/rack/bug/panels/sql_panel/sql_extension.rb

@@ -0,0 +1,11 @@
+if defined?(ActiveRecord) &&  defined?(ActiveRecord::ConnectionAdapters)
+  ActiveRecord::ConnectionAdapters::AbstractAdapter.class_eval do
+    def log_with_rack_bug(sql, name, &block)
+      Rack::Bug::SQLPanel.record(sql, Kernel.caller) do
+        log_without_rack_bug(sql, name, &block)
+      end
+    end
+    
+    alias_method_chain :log, :rack_bug
+  end
+end

data/lib/rack/bug/panels/templates_panel.rb

@@ -0,0 +1,44 @@
+module Rack
+  module Bug
+
+    class TemplatesPanel < Panel
+      require "rack/bug/panels/templates_panel/actionview_extension"
+
+      autoload :Trace,      "rack/bug/panels/templates_panel/trace"
+      autoload :Rendering,  "rack/bug/panels/templates_panel/rendering"
+
+      def self.record(template, &block)
+        return block.call unless Rack::Bug.enabled?
+
+        template_trace.start(template)
+        result = block.call
+        template_trace.finished(template)
+        return result
+      end
+
+      def self.reset
+        Thread.current["rack.bug.template_trace"] = Trace.new
+      end
+
+      def self.template_trace
+        Thread.current["rack.bug.template_trace"] ||= Trace.new
+      end
+
+      def name
+        "templates"
+      end
+
+      def heading
+        "Templates: %.2fms" % (self.class.template_trace.total_time * 1_000)
+      end
+
+      def content
+        result = render_template "panels/templates", :template_trace => self.class.template_trace
+        self.class.reset
+        return result
+      end
+
+    end
+
+  end
+end

data/lib/rack/bug/panels/templates_panel/actionview_extension.rb

@@ -0,0 +1,12 @@
+if defined?(ActionView) && defined?(ActionView::Template)
+  ActionView::Template.class_eval do
+
+    def render_template_with_rack_bug(*args, &block)
+      Rack::Bug::TemplatesPanel.record(path_without_format_and_extension) do
+        render_template_without_rack_bug(*args, &block)
+      end
+    end
+
+    alias_method_chain :render_template, :rack_bug
+  end
+end

data/lib/rack/bug/panels/templates_panel/rendering.rb

@@ -0,0 +1,67 @@
+module Rack
+  module Bug
+    class TemplatesPanel
+      
+      class Rendering
+        attr_accessor :name
+        attr_accessor :start_time
+        attr_accessor :end_time
+        attr_accessor :parent
+        attr_reader :children
+        
+        
+        def initialize(name)
+          @name = name
+          @children = []
+        end
+        
+        def add(rendering)
+          @children << rendering
+          rendering.parent = self
+        end
+        
+        def time
+          @end_time - @start_time
+        end
+        
+        def exclusive_time
+          time - child_time
+        end
+        
+        def child_time
+          children.inject(0.0) { |memo, c| memo + c.time }
+        end
+        
+        def time_summary
+          if children.any?
+            "%.2fms, %.2f exclusive" % [time * 1_000, exclusive_time * 1_000]
+          else
+            "%.2fms" % (time * 1_000)
+          end
+        end
+        def html
+          <<-HTML
+            <li>
+              <p>#{name} (#{time_summary})</p>
+              
+              #{children_html}
+            </li>
+          HTML
+        end
+        
+        def children_html
+          return "" unless children.any?
+          
+          <<-HTML
+            <ul>#{joined_children_html}</ul>
+          HTML
+        end
+        
+        def joined_children_html
+          children.map { |c| c.html }.join
+        end
+      end
+      
+    end
+  end
+end

data/lib/rack/bug/panels/templates_panel/trace.rb

@@ -0,0 +1,34 @@
+module Rack
+  module Bug
+    class TemplatesPanel
+      
+      class Trace
+        
+        def start(template_name)
+          rendering = Rendering.new(template_name)
+          rendering.start_time = Time.now
+          @current.add(rendering)
+          @current = rendering
+        end
+        
+        def finished(template_name)
+          @current.end_time = Time.now
+          @current = @current.parent
+        end
+        
+        def initialize
+          @current = root
+        end
+        
+        def total_time
+          root.child_time
+        end
+        
+        def root
+          @root ||= Rendering.new("root")
+        end
+      end
+      
+    end
+  end
+end

data/lib/rack/bug/panels/timer_panel.rb

@@ -0,0 +1,40 @@
+require "benchmark"
+
+module Rack
+  module Bug
+    
+    class TimerPanel < Panel
+      
+      def name
+        "timer"
+      end
+      
+      def call(env)
+        status, headers, body = nil
+        @times = Benchmark.measure do
+          status, headers, body = @app.call(env)
+        end
+        
+        @measurements = [
+          ["User CPU time",   "%.2fms" % (@times.utime * 1_000)],
+          ["System CPU time", "%.2fms" % (@times.stime * 1_000)],
+          ["Total CPU time",  "%.2fms" % (@times.total * 1_000)],
+          ["Elapsed time",    "%.2fms" % (@times.real  * 1_000)]
+        ]
+        
+        env["rack-bug.panels"] << self
+        return [status, headers, body]
+      end
+      
+      def heading
+        "%.2fms" % (@times.real * 1_000)
+      end
+      
+      def content
+        render_template "panels/timer", :measurements => @measurements
+      end
+      
+    end
+    
+  end
+end

data/lib/rack/bug/params_signature.rb

@@ -0,0 +1,65 @@
+require "digest"
+
+module Rack
+  module Bug
+    
+    class ParamsSignature
+      extend ERB::Util
+      
+      def self.sign(request, hash)
+        parts = []
+        
+        hash.keys.sort.each do |key|
+          parts << "#{key}=#{u(hash[key])}"
+        end
+        
+        signature = new(request).signature(hash)
+        parts << "hash=#{u(signature)}"
+        
+        parts.join("&amp;")
+      end
+      
+      attr_reader :request
+      
+      def initialize(request)
+        @request = request
+      end
+      
+      def secret_key
+        @request.env['rack-bug.secret_key']
+      end
+      
+      def secret_key_blank?
+        secret_key.nil? || secret_key == ""
+      end
+      
+      def validate!
+        if secret_key_blank?
+          raise SecurityError.new("Missing secret key")
+        end
+        
+        if secret_key_blank? || request.params["hash"] != signature(request.params)
+          raise SecurityError.new("Invalid query hash.")
+        end
+      end
+      
+      def signature(params)
+        Digest::SHA1.hexdigest(signature_base(params))
+      end
+      
+      def signature_base(params)
+        signature = []
+        signature << secret_key
+        
+        params.keys.sort.each do |key|
+          next if key == "hash"
+          signature << params[key].to_s
+        end
+        
+        signature.join(":")
+      end
+      
+    end
+    
+  end
+end

data/lib/rack/bug/public/__rack_bug__/bookmarklet.html

@@ -0,0 +1,10 @@
+<html>
+  <head>
+  </head>
+  <body>
+    <br/><br/><br/>
+    <a href="javascript: (function(){var script=document.createElement('script'); script.src='/__rack_bug__/bookmarklet.js'; document.getElementsByTagName('head')[0].appendChild(script);})()">
+      Toggle Rack::Bug
+    </a>
+  </body>
+</html>

data/lib/rack/bug/public/__rack_bug__/bookmarklet.js

@@ -0,0 +1,215 @@
+/**
+*
+*  Secure Hash Algorithm (SHA1)
+*  http://www.webtoolkit.info/
+*
+**/
+
+document.SHA1 = function(msg) {
+  function rotate_left(n,s) {
+    var t4 = ( n<<s ) | (n>>>(32-s));
+    return t4;
+  };
+
+  function lsb_hex(val) {
+    var str="";
+    var i;
+    var vh;
+    var vl;
+
+    for( i=0; i<=6; i+=2 ) {
+      vh = (val>>>(i*4+4))&0x0f;
+      vl = (val>>>(i*4))&0x0f;
+      str += vh.toString(16) + vl.toString(16);
+    }
+    return str;
+  };
+
+  function cvt_hex(val) {
+    var str="";
+    var i;
+    var v;
+
+    for( i=7; i>=0; i-- ) {
+      v = (val>>>(i*4))&0x0f;
+      str += v.toString(16);
+    }
+    return str;
+  };
+
+
+  function Utf8Encode(string) {
+    string = string.replace(/\r\n/g,"\n");
+    var utftext = "";
+
+    for (var n = 0; n < string.length; n++) {
+
+      var c = string.charCodeAt(n);
+
+      if (c < 128) {
+        utftext += String.fromCharCode(c);
+      }
+      else if((c > 127) && (c < 2048)) {
+        utftext += String.fromCharCode((c >> 6) | 192);
+        utftext += String.fromCharCode((c & 63) | 128);
+      }
+      else {
+        utftext += String.fromCharCode((c >> 12) | 224);
+        utftext += String.fromCharCode(((c >> 6) & 63) | 128);
+        utftext += String.fromCharCode((c & 63) | 128);
+      }
+
+    }
+
+    return utftext;
+  };
+
+  var blockstart;
+  var i, j;
+  var W = new Array(80);
+  var H0 = 0x67452301;
+  var H1 = 0xEFCDAB89;
+  var H2 = 0x98BADCFE;
+  var H3 = 0x10325476;
+  var H4 = 0xC3D2E1F0;
+  var A, B, C, D, E;
+  var temp;
+
+  msg = Utf8Encode(msg);
+
+  var msg_len = msg.length;
+
+  var word_array = new Array();
+  for( i=0; i<msg_len-3; i+=4 ) {
+    j = msg.charCodeAt(i)<<24 | msg.charCodeAt(i+1)<<16 |
+    msg.charCodeAt(i+2)<<8 | msg.charCodeAt(i+3);
+    word_array.push( j );
+  }
+
+  switch( msg_len % 4 ) {
+    case 0:
+      i = 0x080000000;
+    break;
+    case 1:
+      i = msg.charCodeAt(msg_len-1)<<24 | 0x0800000;
+    break;
+
+    case 2:
+      i = msg.charCodeAt(msg_len-2)<<24 | msg.charCodeAt(msg_len-1)<<16 | 0x08000;
+    break;
+
+    case 3:
+      i = msg.charCodeAt(msg_len-3)<<24 | msg.charCodeAt(msg_len-2)<<16 | msg.charCodeAt(msg_len-1)<<8  | 0x80;
+    break;
+  }
+
+  word_array.push( i );
+
+  while( (word_array.length % 16) != 14 ) word_array.push( 0 );
+
+  word_array.push( msg_len>>>29 );
+  word_array.push( (msg_len<<3)&0x0ffffffff );
+
+
+  for ( blockstart=0; blockstart<word_array.length; blockstart+=16 ) {
+
+    for( i=0; i<16; i++ ) W[i] = word_array[blockstart+i];
+    for( i=16; i<=79; i++ ) W[i] = rotate_left(W[i-3] ^ W[i-8] ^ W[i-14] ^ W[i-16], 1);
+
+    A = H0;
+    B = H1;
+    C = H2;
+    D = H3;
+    E = H4;
+
+    for( i= 0; i<=19; i++ ) {
+      temp = (rotate_left(A,5) + ((B&C) | (~B&D)) + E + W[i] + 0x5A827999) & 0x0ffffffff;
+      E = D;
+      D = C;
+      C = rotate_left(B,30);
+      B = A;
+      A = temp;
+    }
+
+    for( i=20; i<=39; i++ ) {
+      temp = (rotate_left(A,5) + (B ^ C ^ D) + E + W[i] + 0x6ED9EBA1) & 0x0ffffffff;
+      E = D;
+      D = C;
+      C = rotate_left(B,30);
+      B = A;
+      A = temp;
+    }
+
+    for( i=40; i<=59; i++ ) {
+      temp = (rotate_left(A,5) + ((B&C) | (B&D) | (C&D)) + E + W[i] + 0x8F1BBCDC) & 0x0ffffffff;
+      E = D;
+      D = C;
+      C = rotate_left(B,30);
+      B = A;
+      A = temp;
+    }
+
+    for( i=60; i<=79; i++ ) {
+      temp = (rotate_left(A,5) + (B ^ C ^ D) + E + W[i] + 0xCA62C1D6) & 0x0ffffffff;
+      E = D;
+      D = C;
+      C = rotate_left(B,30);
+      B = A;
+      A = temp;
+    }
+
+    H0 = (H0 + A) & 0x0ffffffff;
+    H1 = (H1 + B) & 0x0ffffffff;
+    H2 = (H2 + C) & 0x0ffffffff;
+    H3 = (H3 + D) & 0x0ffffffff;
+    H4 = (H4 + E) & 0x0ffffffff;
+
+  }
+
+  var temp = cvt_hex(H0) + cvt_hex(H1) + cvt_hex(H2) + cvt_hex(H3) + cvt_hex(H4);
+
+  return temp.toLowerCase();
+}
+
+document.createCookie = function(name,value,days) {
+  if (days) {
+    var date = new Date();
+    date.setTime(date.getTime()+(days*24*60*60*1000));
+    var expires = "; expires="+date.toGMTString();
+  }
+  else
+    var expires = "";
+  document.cookie = name+"="+value+expires+"; path=/";
+}
+
+document.readCookie = function(name) {
+  var nameEQ = name + "=";
+  var ca = document.cookie.split(';');
+  for(var i=0;i < ca.length;i++) {
+    var c = ca[i];
+    while (c.charAt(0)==' ')
+      c = c.substring(1,c.length);
+    if (c.indexOf(nameEQ) == 0)
+      return c.substring(nameEQ.length,c.length);
+  }
+  return null;
+}
+
+document.eraseCookie = function(name) {
+  document.createCookie(name,"",-1);
+}
+
+document.rackBugBookmarklet = function() {
+  if (document.readCookie('rack_bug_password')) {
+    document.eraseCookie('rack_bug_password');
+    document.eraseCookie('rack_bug_enabled');
+    alert('Rack::Bug Disabled');
+  } else {
+    var password = prompt("Rack::Bug password:", "")
+    document.createCookie('rack_bug_password', document.SHA1('rack_bug:'+password));
+    document.createCookie('rack_bug_enabled', "1");
+    alert('Rack::Bug Enabled');
+  }
+}
+
+document.rackBugBookmarklet();