nitro 0.31.0 → 0.40.0

data/lib/nitro/cgi.rb

@@ -78,7 +78,7 @@ class Cgi
 
   def self.structure_param(params, key, val)
     if key =~ /(.+)\[(.+)\]$/ or key =~ /([^\.]+)\.(.+)$/
-      params[$1] ||= Hash.new
+      params[$1] ||= Dictionary.new
       params[$1] = structure_param(params[$1], $2, val)
     elsif key =~ /(.+)\[\]$/
       params[$1] ||= Array.new
@@ -94,7 +94,7 @@ class Cgi
   # in parse_request_params is not done here.
   
   def self.parse_query_string(query_string)
-    params = {}
+    params = Dictionary.new
     
     # gmosx, THINK: better return nil here?
     return params if (query_string.nil? or query_string.empty?)
@@ -261,7 +261,7 @@ class Cgi
             else
               input.read(content_length)
             end
-        if c.nil?
+        if c.nil? || c.empty?
           raise EOFError, "bad content body"
         end
         buf.concat(c)
@@ -315,6 +315,3 @@ class Cgi
 end
   
 end
-
-# * George Moschovitis <gm@navel.gr>
-# * Guillaume Pierronnet <guillaume.pierronnet@gmail.com>

data/lib/nitro/cgi/cookie.rb

@@ -46,6 +46,3 @@ class Cookie
 end
 
 end
-
-# * George Moschovitis <gm@navel.gr>
-

data/lib/nitro/cgi/request.rb

@@ -21,12 +21,13 @@ module Request
   # The parsed query parameters collection.
 
   attr_accessor :params
-  alias_method :query, :params
-
+  alias query params
+  alias parameters params
+  
   # The request cookies.
 
   attr_accessor :cookies
-  alias_method :cookie, :cookies
+  alias cookie cookies
 
   # The request protocol.
 
@@ -58,11 +59,11 @@ module Request
   end
 
   # Returns the domain part of a host.
-   #
-   # === Examples
-   #
-   # www.nitroproject.org: request.domain # => 'nitroproject.org'
-   # www.nitroproject.co.uk: request.domain(2) # => 'nitroproject.co.uk'
+  #
+  # === Examples
+  #
+  # www.nitroproject.org: request.domain # => 'nitroproject.org'
+  # www.nitroproject.co.uk: request.domain(2) # => 'nitroproject.co.uk'
   
   def domain tld_length = 1
     host.split('.').last(1 + tld_length).join('.')
@@ -95,6 +96,12 @@ module Request
     headers['QUERY_STRING']
   end
   
+  # The parameters the action will be called with
+  
+  def action_params
+    headers['ACTION_PARAMS']
+  end
+  
   # The request method. Alternatively you could use the 
   # request method predicates.
   #
@@ -168,7 +175,7 @@ module Request
     not /XMLHttpRequest/i.match(@headers['HTTP_X_REQUESTED_WITH']).nil?
   end
   alias xhr? :xml_http_request?
-  alias ajax? :xml_http_request?
+  alias script? :xml_http_request?
     
   # Return the referer. For the initial page in the
   # clickstream there is no referer, set "/" by default.
@@ -197,7 +204,7 @@ module Request
 
     if @headers.include?('HTTP_X_FORWARDED_FOR') then
       remote_ips = @headers['HTTP_X_FORWARDED_FOR'].split(',').reject do |ip|
-        ip =~ /^unknown$|^(127|10|172\.16|192\.168)\./i
+        ip =~ /^unknown$/i or local_net?(ip)
       end
 
       return remote_ips.first.strip unless remote_ips.empty?
@@ -206,6 +213,30 @@ module Request
     return @headers['REMOTE_ADDR']
   end
 
+  # Request is from a local network? (RFC1918 + localhost)
+  
+  def local_net?(ip = remote_ip)
+    bip = ip.split('.').map{ |x| x.to_i }.pack('C4').unpack('N')[0]
+
+    # 127.0.0.1/32    => 2130706433
+    # 192.168.0.0/16  => 49320
+    # 172.16.0.0/12   => 2753
+    # 10.0.0.0/8      => 10
+
+    { 0 => 2130706433, 16 => 49320, 20 => 2753, 24 => 10}.each do |s,c|
+       return true if (bip >> s) == c
+    end
+    
+    return false
+  end
+  
+  # Request comming from local?
+  
+  def local?(ip = remote_ip)
+    # TODO: should check if requesting machine is the one the server is running
+    return true if ip == '127.0.0.1'
+  end
+
   # The server port.
 
   def port
@@ -242,28 +273,36 @@ module Request
   end
   
   # Lookup a query parameter.
-
-  def [] param
+  #--
+  # TODO: Check if unescape is needed.
+  #++
+  
+  def [](param)
     @params[param]
+=begin
+    if par = @params[param] and par.is_a?(String)
+      CGI.unescape(par)
+    end
+=end
   end
 
   # Set a query parameter.
 
-  def []= param, value
+  def []=(param, value)
     @params[param] = value
   end
   
   # Check if a boolean param (checkbox) is true.
   
-  def true? param
+  def true?(param)
     @params[param] == 'on'
   end
-  alias_method :enabled?, :true?
-  alias_method :boolean, :true?
+  alias enabled? true?
+  alias boolean true?
   
   # Check if a boolean param (checkbox) is false.
    
-  def false? param
+  def false?(param)
     !true?(param)
   end
   
@@ -274,15 +313,19 @@ module Request
   end
   
   # Check if a param is available.
-  
+  #--
+  # gmosx: use nil test instead of has_key? to be more robust.
+  # (nil can be a hash element !)
+  #++
+    
   def has_key? key
-    @params.has_key?(key)
+    !@params[key].nil?
   end
-  alias_method :has_param?, :has_key?
-  alias_method :param?, :has_key?
+  alias has_param? has_key?
+  alias param? has_key?
+  alias has? has_key?
+  alias is? has_key?
+  
 end
 
 end
-
-# * George Moschovitis <gm@navel.gr>
-# * Guillaume Pierronnet <guillaume.pierronnet@laposte.net>

data/lib/nitro/cgi/response.rb

@@ -49,5 +49,3 @@ module Response
 end
 
 end
-
-# * George Moschovitis  <gm@navel.gr>

data/lib/nitro/cgi/{sendfile.rb → send_file.rb}

@@ -16,20 +16,21 @@ module Render
   #
   # === Examples
   #
-  # require 'nitro/cgi/sendfile'
+  # require 'nitro/cgi/send_file'
+  #
   # class MyController < Nitro:Controller
   #   def download(fname)
-  #     sendfile(fname)
+  #     send_file(fname)
   #   end
   # end
   #
   # class MyController < Nitro:Controller
   #   def download()
-  #     sendfile('/etc/password', true)
+  #     send_file('/etc/password', true)
   #   end
   # end
-
-  def sendfile(fname=nil, fullpath=false)
+  
+  def send_file(fname=nil, fullpath=false)
     fname = fullpath ? fname : "#{Server.public_root}/#{fname}"
     f = File.open(fname, "rb")
     @context.response_headers["Cache-control"] = 'private'
@@ -38,8 +39,8 @@ module Render
     @context.out = f
     raise RenderExit
   end
+  alias sendfile send_file
 
 end
 
 end
-

data/lib/nitro/compiler.rb

@@ -1,4 +1,4 @@
-require 'glue/template'
+require 'nitro/template'
 
 require 'nitro/compiler/errors'
 
@@ -59,7 +59,24 @@ class Compiler
   #   ...
   # end
   
-  setting :transformation_pipeline, :default => [StaticInclude, Morphing, Elements, Markup, ScriptCompiler, Cleanup], :doc => 'The default transformation pipeline'
+  setting :transformation_pipeline, :default => [StaticInclude, Morphing, ElementCompiler, MarkupCompiler, ScriptCompiler, Cleanup], :doc => 'The default transformation pipeline'
+  
+  
+  # This specifies if
+  #   def my_action(oid, val)
+  # should handle both
+  #   my_action/1/23
+  # and
+  #   my_action?oid=1;val=23
+  
+  setting :mixin_get_parameters, :default => true
+
+  # Treats
+  #   def my_action(oid, val)
+  # as
+  #   def my_action(oid = nil, val = nil)
+  
+  setting :non_strict_action_calling, :default => false
 
   def initialize(controller = nil)
     @controller = controller
@@ -75,7 +92,8 @@ class Compiler
   # hello_world -> template_root/hello_world.xhtml
   # this__is__my__hello_world -> template_root/this/is/my/hello_world
   
-  def template_for_action(action, ext = Glue::Template.extension)
+  def template_for_action(action, ext = Template.extension)
+    action = action.to_s
     for template_root in @controller.instance_variable_get(:@template_root)
       # attempt to find a template of the form
       # template_root/action.xhtml
@@ -86,7 +104,7 @@ class Compiler
       # attempt to find a template of the form
       # template_root/action/index.xhtml
 
-      path = "#{template_root}/#{action.gsub(/__/, '/')}/#{Glue::Template.default}.#{ext}".squeeze('/')
+      path = "#{template_root}/#{action.gsub(/__/, '/')}/#{Template.default}.#{ext}".squeeze('/')
       return path if File.exist?(path) 
     end
     return nil      
@@ -174,7 +192,7 @@ class Compiler
   #
   # This generated method is called by the dispatcher.
   #
-  # === Glue::Template root overloading
+  # === Template root overloading
   #
   # Nitro provides a nice method of template_root overloading
   # that allows you to use OOP principles with templates.
@@ -229,47 +247,40 @@ class Compiler
         params = params.collect { |p| "@#{p} = @context['#{p}']" }
         code << "#{params.join(';')}"
       end
-                                                                
-      # Try to resolve action parameters. Returns negative
-      # numbers for arbitrary parameters.
-      #--
-      # gmosx: This needs a better implementation. Better means
-      # cleaner and more optimized code.
-      #++
-
-      param_count = @controller.instance_method(action.to_sym).arity 
       
-      if param_count != 0
-        code << %{
-          params = []
-          unless context.query_string.blank?
-            all_params = context.query_string.split(/[&;]/)
-            is_hash = all_params.first.index('=')
-            all_params.each_with_index do |qs, i|
-        }
-        # Don't pass more parameters than the action's arity.
-        if param_count > 0 
-          code << "break unless i < #{param_count};"
+      arity = @controller.instance_method(action.to_sym).arity
+      
+      # Call action with given parameters, raises ActionError when the params
+      # are wrong.
+      # TODO: return 404 or other error code for browser?
+      
+      code << %{
+        params = context.action_params || []
+        
+        # Fill not given parameters with nils
+        
+        arity = (#{arity} < -1) ? (#{arity}.abs - 1) : #{arity}
+        if Nitro::Compiler.non_strict_action_calling
+          arity.times {|i| params[i] ? nil : params[i] = nil }
         end
-        code << %{
-            break if qs.index('=') and not is_hash
-              params << CGI.unescape(qs.split(/=/).last || "")
-            end            
-          end          
-          
-          # Concatenate some extracted parameters.
-#          params.concat(context.params.values)
-          
-          # Fill the array with nils for the missing params.
-          (#{param_count} - params.size).times { params << nil }
-          
+        
+        # When arity zero, ignore params
+        params.clear if arity == 0
+        
+        if Nitro::Compiler.mixin_get_parameters && params.empty? && arity > 0
+          context.params.each_with_index do |(k,v),i|
+            break if i > arity
+            params << v
+          end
+        end
+        
+        begin
           action_return_value = #{action}(*params)
-        }
-      else
-        code << %{
-          action_return_value = #{action}
-        }
-      end
+        rescue ArgumentError => e
+          raise ActionError, "Wrong parameter count for \#{@action_name}(\#{params.join(', ')})."
+        end
+      }
+      
       code << %{
         unless :stop == action_return_value      
       }
@@ -285,14 +296,15 @@ class Compiler
     # better practice to place the output related code in an 
     # external template file.
 
-    # Take :view annotation into account.
+    # Take :template annotation into account.
     
-    view = @controller.ann(action.to_sym).view # FIXME
-    view = action if view.nil?
+    unless template = @controller.ann(action.to_sym)[:template] # FIXME
+      template = action
+    end
 
     # Search the [controller] class and it's ancestors for the template
     
-    template_path = template_for_action(view.to_s) 
+    template_path = template_for_action(template.to_s) 
     if template_path or @controller.instance_methods.include?("#{action}_template")
       valid = true
       code << %{
@@ -313,7 +325,7 @@ class Compiler
 
     if Render.redirect_on_empty
       code << %{
-        redirect_referer if @out.empty?
+        redirect_to_referer if @out.empty?
       }
     end
 
@@ -354,12 +366,12 @@ class Compiler
     # Typically used to precompile css templates.
     
     def precompile(filename)
-      src = File.join(Glue::Template.root, "#{filename}t")
+      src = File.join(Template.root, "#{filename}t")
       dst = File.join(Server.public_root, filename)
       
       if (!File.exist?(dst)) or (File.mtime(src) > File.mtime(dst))
         Logger.info "Compiling template '#{src}' to '#{dst}'."
-        template = Glue::FileTemplate.new(src)
+        template = FileTemplate.new(src)
         File.open(dst, 'w') do |f|
           f << template.process
         end
@@ -371,8 +383,3 @@ class Compiler
 end
 
 end
-
-# * George Moschovitis <gm@navel.gr>
-# * Chris Farmiloe <chris.farmiloe@farmiloe.com>
-# * Rob Pitt <rob@motionpath.co.uk>
-# * Jonas Pfenniger <zimba.tm@gmail.com>

data/lib/nitro/compiler/cleanup.rb

@@ -11,6 +11,3 @@ module Cleanup
 end
 
 end
-
-# * George Moschovitis <gm@navel.gr>
-# * Chris Farmiloe <chris.farmiloe@farmiloe.com>

data/lib/nitro/compiler/elements.rb

@@ -3,7 +3,7 @@ require 'rexml/streamlistener'
 require 'facet/class/by_name'
 
 require 'nitro/element'
-require "glue/html"
+require 'glue/html'
 
 
 module Nitro
@@ -62,6 +62,7 @@ class Elements # :nodoc: all
     def tag_end(name)    
       # check if the name starts with the element prefix, or
       # is capitalized.
+
       if is_element? name
         obj, @buffer, @parent = @stack.pop
         @buffer << obj.render
@@ -71,10 +72,10 @@ class Elements # :nodoc: all
     end
 
 
-    # Check if a tag is a Nitro::Element. If found, it also tries to
-    # auto-extend the klass.
-    #
-    # returns the Element class if found
+    # Check if a tag is a Nitro::Element. If found, it also 
+    # tries to auto-extend the klass. Returns the Element class 
+    # if found.
+
     def is_element?(name)
       # Doesn't support modulized classes
 #      name = name.demodulize
@@ -82,34 +83,42 @@ class Elements # :nodoc: all
 
       name = name.gsub(PREFIX_RE,'').camelize if name =~ PREFIX_RE
 
-      # First try to use Nitro::Element::xxx then ::xxx
+      # Try to use Controller::xxx
+      #--
+      # gmosx, THINK: this looks a bit dangerous to me!
+      #++
       
       begin
-        klass = Class.by_name("Nitro::Element::#{name}")
+        #--
+        # gmosx, FIXME: Class.by_name also returns top level
+        # classes, how can we fix this?
+        #++
+        klass = Class.by_name("#{@compiler.controller}::#{name}")
       rescue
+        # drink it!
       end
 
-      # Look into the module the controller's module if any
+      # Try to use the Controller's :elements annotation
 
-      begin
-        namespace = @compiler.controller.name
-        if /::/ =~ namespace
-          namespace = namespace.gsub( /::[a-zA-Z]+$/, "::#{name}" )
-          klass = Class.by_name(namespace)
+      if (!klass) and namespace = @compiler.controller.ann.self[:element_namespace]
+        begin
+          klass = Class.by_name("#{namespace}::#{name}")
+        rescue
+          # drink it!
         end
-      rescue
-      end unless klass
-
-      # Look in the root module
+      end
 
+      # Try to use Nitro::Element::xxx then ::xxx
+      
       begin
-        klass = Class.by_name(name)
+        klass = Class.by_name("Nitro::Element::#{name}")
       rescue
+        # drink it!
       end unless klass
 
-      return false unless klass.kind_of?( Class )
+      return false unless klass.kind_of? Class
 
-      # Try to auto-extend
+      # Try to auto-extend.
 
       unless klass.ancestors.include? Nitro::Element
         if Element.auto_extend
@@ -131,7 +140,7 @@ class Elements # :nodoc: all
     end
 
     def comment(c)
-      unless Glue::Template.strip_xml_comments
+      unless Template.strip_xml_comments
         @buffer << "<!--#{c}-->"
       end
     end
@@ -163,14 +172,8 @@ class Elements # :nodoc: all
   end
 end
 
-# An (old) alias.
-
-unless const_defined? :ElementProcessor
-   ElementProcessor = Elements
+unless const_defined? :ElementCompiler
    ElementCompiler = Elements
 end
 
 end
-
-# * George Moschovitis <gm@navel.gr>
-# * Chris Farmiloe <chris.farmiloe@farmiloe.com>