spiderfw 0.5.13 → 0.5.14

data/lib/spiderfw/utils/secure_random.rb

@@ -0,0 +1,223 @@
+#--
+# From ActiveSupport
+# Copyright (c) 2005 David Heinemeier Hansson
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#++
+
+begin
+  require 'securerandom'
+rescue LoadError
+end
+
+module Spider
+  if defined?(::SecureRandom)
+    # Use Ruby's SecureRandom library if available.
+    SecureRandom = ::SecureRandom # :nodoc:
+  else
+    # = Secure random number generator interface.
+    #
+    # This library is an interface for secure random number generator which is
+    # suitable for generating session key in HTTP cookies, etc.
+    #
+    # It supports following secure random number generators.
+    #
+    # * openssl
+    # * /dev/urandom
+    # * Win32
+    #
+    # *Note*: This module is based on the SecureRandom library from Ruby 1.9,
+    # revision 18786, August 23 2008. It's 100% interface-compatible with Ruby 1.9's
+    # SecureRandom library.
+    #
+    # == Example
+    #
+    #  # random hexadecimal string.
+    #  p SecureRandom.hex(10) # => "52750b30ffbc7de3b362"
+    #  p SecureRandom.hex(10) # => "92b15d6c8dc4beb5f559"
+    #  p SecureRandom.hex(11) # => "6aca1b5c58e4863e6b81b8"
+    #  p SecureRandom.hex(12) # => "94b2fff3e7fd9b9c391a2306"
+    #  p SecureRandom.hex(13) # => "39b290146bea6ce975c37cfc23"
+    #  ...
+    #
+    #  # random base64 string.
+    #  p SecureRandom.base64(10) # => "EcmTPZwWRAozdA=="
+    #  p SecureRandom.base64(10) # => "9b0nsevdwNuM/w=="
+    #  p SecureRandom.base64(10) # => "KO1nIU+p9DKxGg=="
+    #  p SecureRandom.base64(11) # => "l7XEiFja+8EKEtY="
+    #  p SecureRandom.base64(12) # => "7kJSM/MzBJI+75j8"
+    #  p SecureRandom.base64(13) # => "vKLJ0tXBHqQOuIcSIg=="
+    #  ...
+    #
+    #  # random binary string.
+    #  p SecureRandom.random_bytes(10) # => "\016\t{\370g\310pbr\301"
+    #  p SecureRandom.random_bytes(10) # => "\323U\030TO\234\357\020\a\337"
+    #  ...
+    module SecureRandom
+      # SecureRandom.random_bytes generates a random binary string.
+      #
+      # The argument n specifies the length of the result string.
+      #
+      # If n is not specified, 16 is assumed.
+      # It may be larger in future.
+      #
+      # If secure random number generator is not available,
+      # NotImplementedError is raised.
+      def self.random_bytes(n=nil)
+        n ||= 16
+
+        unless defined? OpenSSL
+          begin
+            require 'openssl'
+          rescue LoadError
+          end
+        end
+
+        if defined? OpenSSL::Random
+          return OpenSSL::Random.random_bytes(n)
+        end
+
+        if !defined?(@has_urandom) || @has_urandom
+          flags = File::RDONLY
+          flags |= File::NONBLOCK if defined? File::NONBLOCK
+          flags |= File::NOCTTY if defined? File::NOCTTY
+          flags |= File::NOFOLLOW if defined? File::NOFOLLOW
+          begin
+            File.open("/dev/urandom", flags) {|f|
+              unless f.stat.chardev?
+                raise Errno::ENOENT
+              end
+              @has_urandom = true
+              ret = f.readpartial(n)
+              if ret.length != n
+                raise NotImplementedError, "Unexpected partial read from random device"
+              end
+              return ret
+            }
+          rescue Errno::ENOENT
+            @has_urandom = false
+          end
+        end
+
+        if !defined?(@has_win32)
+          begin
+            require 'Win32API'
+
+            crypt_acquire_context = Win32API.new("advapi32", "CryptAcquireContext", 'PPPII', 'L')
+            @crypt_gen_random = Win32API.new("advapi32", "CryptGenRandom", 'LIP', 'L')
+
+            hProvStr = " " * 4
+            prov_rsa_full = 1
+            crypt_verifycontext = 0xF0000000
+
+            if crypt_acquire_context.call(hProvStr, nil, nil, prov_rsa_full, crypt_verifycontext) == 0
+              raise SystemCallError, "CryptAcquireContext failed: #{lastWin32ErrorMessage}"
+            end
+            @hProv, = hProvStr.unpack('L')
+
+            @has_win32 = true
+          rescue LoadError
+            @has_win32 = false
+          end
+        end
+        if @has_win32
+          bytes = " " * n
+          if @crypt_gen_random.call(@hProv, bytes.size, bytes) == 0
+            raise SystemCallError, "CryptGenRandom failed: #{lastWin32ErrorMessage}"
+          end
+          return bytes
+        end
+
+        raise NotImplementedError, "No random device"
+      end
+
+      # SecureRandom.hex generates a random hex string.
+      #
+      # The argument n specifies the length of the random length.
+      # The length of the result string is twice of n.
+      #
+      # If n is not specified, 16 is assumed.
+      # It may be larger in future.
+      #
+      # If secure random number generator is not available,
+      # NotImplementedError is raised.
+      def self.hex(n=nil)
+        random_bytes(n).unpack("H*")[0]
+      end
+
+      # SecureRandom.base64 generates a random base64 string.
+      #
+      # The argument n specifies the length of the random length.
+      # The length of the result string is about 4/3 of n.
+      #
+      # If n is not specified, 16 is assumed.
+      # It may be larger in future.
+      #
+      # If secure random number generator is not available,
+      # NotImplementedError is raised.
+      def self.base64(n=nil)
+        [random_bytes(n)].pack("m*").delete("\n")
+      end
+
+      # SecureRandom.random_number generates a random number.
+      #
+      # If an positive integer is given as n,
+      # SecureRandom.random_number returns an integer:
+      # 0 <= SecureRandom.random_number(n) < n.
+      #
+      # If 0 is given or an argument is not given,
+      # SecureRandom.random_number returns an float:
+      # 0.0 <= SecureRandom.random_number() < 1.0.
+      def self.random_number(n=0)
+        if 0 < n
+          hex = n.to_s(16)
+          hex = '0' + hex if (hex.length & 1) == 1
+          bin = [hex].pack("H*")
+          mask = bin[0]
+          mask |= mask >> 1
+          mask |= mask >> 2
+          mask |= mask >> 4
+          begin
+            rnd = SecureRandom.random_bytes(bin.length)
+            rnd[0] = rnd[0] & mask
+          end until rnd < bin
+          rnd.unpack("H*")[0].hex
+        else
+          # assumption: Float::MANT_DIG <= 64
+          i64 = SecureRandom.random_bytes(8).unpack("Q")[0]
+          Math.ldexp(i64 >> (64-Float::MANT_DIG), -Float::MANT_DIG)
+        end
+      end
+
+      # Following code is based on David Garamond's GUID library for Ruby.
+      def self.lastWin32ErrorMessage # :nodoc:
+        get_last_error = Win32API.new("kernel32", "GetLastError", '', 'L')
+        format_message = Win32API.new("kernel32", "FormatMessageA", 'LPLLPLPPPPPPPP', 'L')
+        format_message_ignore_inserts = 0x00000200
+        format_message_from_system    = 0x00001000
+
+        code = get_last_error.call
+        msg = "\0" * 1024
+        len = format_message.call(format_message_ignore_inserts + format_message_from_system, 0, code, 0, msg, 1024, nil, nil, nil, nil, nil, nil, nil, nil)
+        msg[0, len].tr("\r", '').chomp
+      end
+    end
+  end
+end

data/lib/spiderfw/version.rb

@@ -1,3 +1,3 @@
 module Spider
-    VERSION = File.read(File.dirname(__FILE__)+'/../../VERSION')
+    VERSION = File.read(File.dirname(__FILE__)+'/../../VERSION').strip
 end

data/lib/spiderfw/widget/widget.rb

@@ -11,7 +11,7 @@ module Spider
         include HTTPMixin
         
         attr_accessor :parent
-        attr_accessor :request, :scene, :widgets, :template, :id, :id_path, :containing_template, :target_mode
+        attr_accessor :request, :scene, :widgets, :template, :id, :id_path, :containing_template, :is_target_ancestor, :is_target_descendant
         attr_reader :attributes, :widget_attributes, :css_classes, :widgets_runtime_content
         attr_accessor :active
         
@@ -26,6 +26,10 @@ module Spider
             def inherited(subclass)
                 subclass.instance_variable_set(:@attributes, attributes.clone)
                 subclass.instance_variable_set(:@scene_attributes, @scene_attributes.clone) if @scene_attributes
+                subclass.instance_variable_set(:@plugins, @plugins.clone) if @plugins
+                subclass.instance_variable_set(:@default_assets, @default_assets.clone) if @default_assets
+                @subclasses ||= []
+                @subclasses << subclass
                 super
             end
             
@@ -169,12 +173,6 @@ module Spider
                 end
 
                 Hpricot::Elements[*overrides].remove
-                plugins.each do |plugin|
-                    name = plugin['name']
-                    mod = self.plugin(name)
-                    next unless mod
-                    overrides += mod.get_overrides
-                end
                 return [doc.to_s, overrides]
             end
             
@@ -192,6 +190,7 @@ module Spider
             def add_plugin(name, mod)
                 @plugins ||= {}
                 @plugins[name] = mod
+                @subclasses.each{ |sub| sub.add_plugin(name, mod) } if @subclasses
             end
             
             def plugin(name)
@@ -199,12 +198,41 @@ module Spider
                 @plugins[name]
             end
             
+            def default_asset(ass)
+                @default_assets ||= []
+                @default_assets << ass
+            end
+            
+            def assets
+                r = []
+                if @default_assets
+                    @default_assets.each do |ass|
+                        if ass.is_a?(Hash)
+                            ass[:app] ||= self.class.app
+                            r << ass
+                        else
+                            r += Spider::Template.get_named_asset(ass)
+                        end
+                    end
+                end
+                if @plugins
+                    @plugins.each do |name, mod|
+                        r += mod.get_assets
+                    end
+                end
+                r
+            end
+            
         end
         
         i_attribute :use_template
         attribute :"sp:target-only"
         attribute :class
         
+        default_asset 'jquery'
+        default_asset 'spider'
+        
+        
         def initialize(request, response, scene=nil)
             super
             @is_target = false
@@ -213,27 +241,28 @@ module Spider
             @id_path = []
             @widget_attributes = {}
             locale = @request.locale.language
-            include_js = [
-                '/js/jquery/jquery-1.4.2.js', '/js/inheritance.js', '/js/spider.js', '/js/jquery/plugins/jquery.query-2.1.6.js',
-                '/js/jquery/plugins/jquery.form.js',
-                '/js/plugins/plugin.js'
-            ]
-            # include_js << [
-            #     '/js/jquery/jquery-ui/development-bundle/ui/jquery-ui-1.7.2.custom.js',
-            #     #'/js/jquery/jquery-ui/development-bundle/ui/jquery-ui-1.7.2.custom.min.js',
-            #     "/js/jquery/jquery-ui/development-bundle/ui/i18n/ui.datepicker-#{locale}.js"
+            # include_js = [
+            #     '/js/jquery/jquery-1.4.2.js', '/js/inheritance.js', '/js/spider.js', '/js/jquery/plugins/jquery.query-2.1.6.js',
+            #     '/js/jquery/plugins/jquery.form.js',
+            #     '/js/plugins/plugin.js'
+            # ]
+            # # include_js << [
+            # #     '/js/jquery/jquery-ui/development-bundle/ui/jquery-ui-1.7.2.custom.js',
+            # #     #'/js/jquery/jquery-ui/development-bundle/ui/jquery-ui-1.7.2.custom.min.js',
+            # #     "/js/jquery/jquery-ui/development-bundle/ui/i18n/ui.datepicker-#{locale}.js"
+            # # ]
+            # include_css = [
+            #     '/css/spider.css', '/js/jquery/jquery-ui/css/smoothness/jquery-ui-1.7.2.custom.css', 
             # ]
-            include_css = [
-                '/css/spider.css', '/js/jquery/jquery-ui/css/smoothness/jquery-ui-1.7.2.custom.css', 
-            ]
             @assets = []
-            include_js.each{ |js| @assets << {:type => :js, :src => Spider::Components.pub_url+js, :path => Spider::Components.pub_path+js}}
-            include_css.each{ |css| @assets << {:type => :css, :src => Spider::Components.pub_url+css, :path => Spider::Components.pub_path+css}}
-            
+            # include_js.each{ |js| @assets << {:type => :js, :src => Spider::Components.pub_url+js, :path => Spider::Components.pub_path+js}}
+            # include_css.each{ |css| @assets << {:type => :css, :src => Spider::Components.pub_url+css, :path => Spider::Components.pub_path+css}}
+            # 
             @use_template ||= self.class.default_template
             @css_classes = []
             @widgets_runtime_content = {}
             @widget_procs = {}
+            @runtime_overrides = []
         end
         
         def full_id
@@ -268,31 +297,41 @@ module Spider
         end
         
         def before(action='')
-            Spider.logger.debug("Widget #{self} before(#{action})")
+            #Spider.logger.debug("Widget #{self} before(#{action})")
             widget_init(action)
-            init_widgets unless @init_widgets_done
+            @before_done = true
             super
         end
         
         def widget_before(action='')
-            Spider.logger.debug("Widget #{self} widget_before(#{action})")
+            #Spider.logger.debug("Widget #{self} widget_before(#{action})")
             widget_init(action)
+            return unless active?
+            #Spider.logger.debug("Preparing widget #{self}")
             prepare
             prepare_scene(@scene)
             @before_done = true
         end
         
         
+        # Active widgets get prepared. When calling a deep widget, the ancestors will be active.
         def active?
-            
-            return @active unless @active.nil?
-            return @active = true if @is_target
-            return @active = false if attributes[:"sp:target-only"] == "true"
-            @active = (!@request.params['_wt'] || @target_mode)
+            return true if @active
+            return true unless target_mode? || attributes[:"sp:target-only"]
+            return true if @is_target || @is_target_ancestor
+            return true if @is_target_descendant && !attributes[:"sp:target-only"]
+            return false
+        end
+        
+        # When in target mode, a widget will be run only if it is the target, or one of its subwidgets
+        def run?
+            return true unless target_mode? || attributes[:"sp:target-only"]
+            return true if @is_target # || @is_target_ancestor
+            return true if @is_target_descendant && !attributes[:"sp:target-only"]
+            return false
         end
         
         def active=(val)
-            
             @active = val
         end
         
@@ -338,6 +377,7 @@ module Spider
                 @css_classes += @attributes[:class].split(/\s+/)
             end
         end
+
         
         # Recursively instantiates the subwidgets.
         def prepare(action='')
@@ -350,8 +390,27 @@ module Spider
             end
         end
         
-        # Instantiates this widget's own subwidgets.
         def init_widgets(template=@template)
+            load_widgets(template)
+            @widgets.each do |id, w| 
+                w.parent = self
+                w.is_target_descendant = true if @is_target || @is_target_descendant
+                w.active = true if run?
+            end
+            if !@is_target && @widget_target
+                first, rest = @widget_target.split('/', 2)
+                @_widget = find_widget(first)
+                @_widget.is_target_ancestor = true
+                @_widget.widget_target = rest
+                @_widget.is_target = true unless rest
+                @_widget_rest = rest || ''
+            end
+            @init_widgets_done = true
+            
+        end
+        
+        # Instantiates this widget's own subwidgets.
+        def load_widgets(template=@template)
             if (self.class.scene_attributes)
                 self.class.scene_attributes.each do |name|
                     @scene[name] = instance_variable_get("@#{name}")
@@ -359,14 +418,11 @@ module Spider
             end
             template.request = @request
             template.response = @response
+            template.runtime_overrides += @runtime_overrides
             template.init(@scene)
             template.widgets.each do |name, w|
                 add_widget(w)
             end
-            @widgets.each do |id, w| 
-                w.parent = self
-            end
-            @init_widgets_done = true
         end
         
         def set_widget_attributes
@@ -414,10 +470,6 @@ module Spider
             @did_run
         end
         
-        def run?
-            @is_target || (!@target_mode && !attributes[:"sp:target-only"])
-        end
-        
         def init_widget_done?
             @init_widget_done
         end
@@ -430,7 +482,7 @@ module Spider
         def render
             prepare_scene(@scene)
             set_scene_vars(@scene)
-            @template.render(@scene) unless @target_mode && !@is_target
+            @template.render(@scene) unless @is_target_ancestor && !@is_target
         end
         
         def execute(action='', *params)
@@ -443,15 +495,10 @@ module Spider
                     run
                     render
                 end
-            elsif (@widget_target)
-                first, rest = @widget_target.split('/', 2)
-                @_widget = find_widget(first)
-                @_widget.target_mode = true
-                @_widget.widget_target = rest
-                @_widget.is_target = true unless rest
+            elsif (@_widget)
                 @_widget.set_action(widget_execute)
-                @_widget.before(rest, *params)
-                @_widget.execute(rest, *params)
+                @_widget.before(@_widget_rest, *params)
+                @_widget.execute(@_widget_rest, *params)
             else
                 super
             end
@@ -496,6 +543,8 @@ module Spider
         end
         
         def create_widget(klass, id,  *params)
+            params.unshift(@response)
+            params.unshift(@request)
             obj = klass.new(*params)
             obj.id = id
             add_widget(obj)
@@ -543,7 +592,35 @@ module Spider
             parse_runtime_content(doc, src_path) if doc.children && doc.root && doc.root.children
         end
         
+        def replace_content_vars(str, scene=nil)
+            scene ||= @parent && @parent.scene ? @parent.scene : @scene
+            res = ""
+            Spider::Template.scan_text(str) do |type, val, full|
+                case type
+                when :plain, :escaped_expr
+                    res << full
+                when :expr
+                    Spider::Template.scan_scene_vars(val) do |vtype, vval|
+                        case vtype
+                        when :plain
+                            res << vval
+                        when :var
+                            res << scene[vval.to_sym].to_s
+                        end
+                    end
+                end
+            end
+        end
+        
         def parse_runtime_content(doc, src_path=nil)
+            doc.search('sp:plugin').each do |plugin|
+                # we don't call add_plugin here because the overrides don't have to be added at runtime, since
+                # they have already been processed when compiling the instance
+                name = plugin['name'].to_sym
+                mod = self.class.plugin(name)
+                next unless mod
+                self.extend(mod)
+            end
             # doc.search('sp:plugin').each do |plugin|
             #     name = plugin['name']
             #     mod = self.class.plugin(name)
@@ -636,7 +713,7 @@ module Spider
             end
             return w
         end
-        
+                
         def prepare_scene(scene)
             scene = super
             
@@ -649,6 +726,11 @@ module Spider
             if (@parent && @parent.respond_to?(:scene) && @parent.scene)
                 scene._parent = @parent.scene
             end
+            par = @parent
+            while par && par.is_a?(Widget)
+                par = par.parent
+            end
+            scene.controller_scene = par.scene if par
             scene.extend(WidgetScene)
             return scene
         end
@@ -689,12 +771,22 @@ module Spider
             @widget_procs[first.to_sym] ||= []
             @widget_procs[first.to_sym] << {:target => rest, :proc => proc }
         end
-            
+        
+        def add_plugin(name)
+            mod = self.class.plugin(name)
+            return unless mod
+            self.extend(mod)
+            @runtime_overrides << [name, mod.get_overrides, mod.overrides_path]
+        end
         
     end
     
     module WidgetScene
         
+        def _wt
+            self[:widget][:id_path].join('/')
+        end
+        
         def widget_target
             "#{self[:request][:path]}?_wt=#{self[:widget][:id_path].join('/')}"
         end

data/lib/spiderfw/widget/widget_plugin.rb

@@ -9,7 +9,7 @@ module Spider
         
         module ModuleMethods
             
-            def self.plugin_name
+            def plugin_name
                 @plugin_name
             end
             
@@ -19,9 +19,13 @@ module Spider
                 @path = File.dirname(File.expand_path(caller[0].split(':')[0]))
             end
             
+            def overrides_path
+                @path+'/'+Inflector.underscore(self.to_s.split('::')[-1])+'.shtml'
+            end
+            
             def get_overrides
                 overrides = []
-                path = @path+'/'+Inflector.underscore(self.to_s.split('::')[-1])+'.shtml'
+                path = overrides_path
                 doc = open(path){ |f| Hpricot.XML(f) }
                 doc.root.each_child do |child|
                     next unless child.is_a?(Hpricot::Elem)
@@ -30,6 +34,13 @@ module Spider
                 return overrides
             end
             
+            def get_assets
+                path = overrides_path
+                return open(path){ |f| Hpricot.XML(f) }.root.children_of_type('tpl:asset').map{ |el|
+                    Spider::Template.parse_asset_element(el)
+                }
+            end
+            
         end
         
     end