riddl 0.99.105

data/lib/riddl/utils/xsloverlay.rb

@@ -0,0 +1,21 @@
+module Riddl
+  module Utils
+
+    class XSLOverlay < Riddl::Implementation
+      def response
+        doc = if @p[0].value.class == String 
+          XML::Smart::string(@p[0].value)
+        elsif @p[0].value.respond_to?(:read)
+          XML::Smart::string(@p[0].value.read)
+        else
+          nil
+        end
+        unless doc.nil?
+          doc.root.add_before "?xml-stylesheet", "href='#{@a[0]}' type='text/xsl'"
+          Riddl::Parameter::Complex.new("content",@p[0].mimetype,doc.to_s)
+        end  
+      end
+    end
+      
+  end
+end

data/lib/riddl/wrapper.rb

@@ -0,0 +1,280 @@
+require 'rubygems'
+require 'open-uri'
+gem 'xml-smart', '>= 0.3.0'
+require 'xml/smart'
+
+module Riddl
+  class Wrapper
+    class WrapperUtils
+      def get_resource_deep(path,pres)
+        #{{{
+        path.split('/').each do |pa|
+          next if pa == ""
+          if pres.resources.has_key?(pa)
+            pres = pres.resources[pa]
+          else
+            return nil
+          end
+        end
+        pres
+        #}}}
+      end
+      def rpaths(res,what)
+        #{{{
+        what += what == '' ? '/' : res.path
+        ret = [[what,res.recursive]]
+        res.resources.each do |name,r|
+          ret += rpaths(r,what == '/' ? what : what + '/')
+        end
+        ret.sort!
+        ret
+        #}}}
+      end  
+      protected :rpaths, :get_resource_deep
+    end
+  end  
+end
+    
+require File.expand_path(File.dirname(__FILE__) + '/wrapper/description')
+require File.expand_path(File.dirname(__FILE__) + '/wrapper/declaration')
+require File.expand_path(File.dirname(__FILE__) + '/wrapper/messageparser')
+require File.expand_path(File.dirname(__FILE__) + '/wrapper/resourcechecker')
+require File.expand_path(File.dirname(__FILE__) + '/wrapper/layerchecker')
+require File.expand_path(File.dirname(__FILE__) + '/error')
+require File.expand_path(File.dirname(__FILE__) + '/handlers')
+require File.expand_path(File.dirname(__FILE__) + '/roles')
+
+module Riddl
+  class Wrapper
+    #{{{
+    VERSION_MAJOR = 1
+    VERSION_MINOR = 0
+    VERSION = "#{VERSION_MAJOR}.#{VERSION_MINOR}"
+    DESCRIPTION = "http://riddl.org/ns/description/#{VERSION}"
+    DECLARATION = "http://riddl.org/ns/declaration/#{VERSION}"
+    XINCLUDE = "http://www.w3.org/2001/XInclude"
+    DESCRIPTION_FILE = "#{File.dirname(__FILE__)}/ns/description/#{VERSION_MAJOR}.#{VERSION_MINOR}/description.rng"
+    DECLARATION_FILE = "#{File.dirname(__FILE__)}/ns/declaration/#{VERSION_MAJOR}.#{VERSION_MINOR}/declaration.rng"
+    COMMON = "datatypeLibrary=\"http://www.w3.org/2001/XMLSchema-datatypes\" xmlns=\"#{DESCRIPTION}\" xmlns:xi=\"http://www.w3.org/2001/XInclude\""
+    CHECK = "<element name=\"check\" datatypeLibrary=\"http://www.w3.org/2001/XMLSchema-datatypes\" xmlns=\"http://relaxng.org/ns/structure/1.0\"><data/></element>"
+    #}}}
+
+    def initialize(name,get_description=false)
+      #{{{
+      @doc = nil
+
+      fpath = nil
+      if name.is_a?(XML::Smart::Dom)
+        @doc = name
+      else  
+        begin
+          fh = name.respond_to?(:read) ? name : open(name)
+          @doc = XML::Smart.string(fh.read)
+          fh.close
+          fpath = File.dirname(fh.path) if fh.is_a?(File) || fh.is_a?(Tempfile)
+        rescue
+          begin
+            @doc = XML::Smart.string(name)
+          rescue
+            raise SpecificationError, "#{name.inspect} is no RIDDL description or declaration (neither a file, url or string)."
+          end
+        end  
+      end  
+      @doc.register_namespace 'x', XINCLUDE
+      @doc.find('//x:include/@href').each do |i|
+        if i.value =~ /^http:\/\/(www\.)?riddl\.org(\/ns\/common-patterns\/.*)/
+          t = File.expand_path(File.dirname(__FILE__)) + $2
+          i.value = t if File.exists?(t)
+        end
+      end
+      fpath.nil? ? @doc.xinclude! : @doc.xinclude!(fpath)
+      @doc.register_namespace 'des', DESCRIPTION
+      @doc.register_namespace 'dec', DECLARATION
+      qname = @doc.root.qname
+      @is_description = qname.href == DESCRIPTION && qname.name ==  'description'
+      @is_declaration = qname.href == DECLARATION && qname.name ==  'declaration'
+  
+      if @is_description && get_description
+        n = @doc.root.children
+        if n.empty?
+          @doc.root.add("message",:name=>"riddl-description-request").add("parameter",:name=>"riddl-description",:type=>"string")
+          @doc.root.add("message",:name=>"riddl-description-response").add("parameter",:name=>"riddl-description",:mimetype=>"text/xml")
+        else
+          n.first.add_before("message",:name=>"riddl-description-response").add("parameter",:name=>"riddl-description",:mimetype=>"text/xml")
+          n.first.add_before("message",:name=>"riddl-description-request").add("parameter",:name=>"riddl-description",:type=>"string")
+        end  
+
+        r = @doc.find("/des:description/des:resource")
+        unless r.empty?
+          n = r.first.children
+          if n.empty?
+            r.add("get",:in=>'riddl-description-request',:out=>'riddl-description-response')
+          else  
+            n.first.add_before("get",:in=>'riddl-description-request',:out=>'riddl-description-response')
+          end  
+        end
+      end
+      @declaration = @description = nil
+      #}}}
+    end
+
+    def declaration
+      #{{{
+      if @is_declaration
+        @declaration = Riddl::Wrapper::Declaration.new(@doc)
+      end
+      @declaration
+      #}}}
+    end
+      
+    def description
+      #{{{
+      if @is_description
+        @description = Riddl::Wrapper::Description.new(@doc)
+      end
+      @description
+      #}}}
+    end
+
+    def role(path) #{{{
+      description
+      declaration
+      return @description.get_resource(path).role if @is_description
+      return @declaration.get_resource(path).role if @is_declaration
+      nil
+    end #}}}
+
+    def io_messages(path,operation,params,headers)
+      #{{{
+      description
+      declaration
+     
+      req = @description.get_resource(path).access_methods if @is_description
+      req = @declaration.get_resource(path).composition    if @is_declaration
+
+      mp = MessageParser.new(params,headers)
+      if req.has_key?(operation)
+        if @is_description
+          r = req[operation][0]
+          r.select{|o|o.class==Riddl::Wrapper::Description::RequestInOut}.each do |o|
+            return IOMessages.new(o.in, o.out) if mp.check(o.in)
+          end
+          r.select{|o|o.class==Riddl::Wrapper::Description::RequestTransformation}.each do |o|
+            # TODO guess structure from input, create new output structure
+            return IOMessages.new(Riddl::Wrapper::Description::Star.new, Riddl::Wrapper::Description::Star.new)
+          end
+          r.select{|o|o.class==Riddl::Wrapper::Description::RequestStarOut}.each do |o|
+            return IOMessages.new(Riddl::Wrapper::Description::Star.new, o.out)
+          end
+          r.select{|o|o.class==Riddl::Wrapper::Description::RequestPass}.each do |o|
+            return IOMessages.new(Riddl::Wrapper::Description::Star.new, Riddl::Wrapper::Description::Star.new)
+          end
+          r.select{|o|o.class==Riddl::Wrapper::Description::WebSocket}.each do |o|
+            return IOMessages.new(nil,nil,nil,o.result.interface)
+          end
+        end  
+        if @is_declaration
+          r = req[operation]
+          r.select{|o|o.result.class==Riddl::Wrapper::Description::RequestInOut}.each do |o|
+            return IOMessages.new(o.result.in, o.result.out, o.route, o.result.interface) if mp.check(o.result.in)
+          end
+          r.select{|o|o.result.class==Riddl::Wrapper::Description::RequestTransformation}.each do |o|
+            # TODO guess structure from input, create new output structure
+            return IOMessages.new(Riddl::Wrapper::Description::Star.new, Riddl::Wrapper::Description::Star.new, o.route, o.result.interface)
+          end
+          r.select{|o|o.result.class==Riddl::Wrapper::Description::RequestStarOut}.each do |o|
+            return IOMessages.new(Riddl::Wrapper::Description::Star.new, o.result.out, o.route, o.result.interface)
+          end
+          r.select{|o|o.result.class==Riddl::Wrapper::Description::RequestPass}.each do |o|
+            return IOMessages.new(Riddl::Wrapper::Description::Star.new, Riddl::Wrapper::Description::Star.new, o.route, o.result.interface)
+          end
+          r.select{|o|o.result.class==Riddl::Wrapper::Description::WebSocket}.each do |o|
+            return IOMessages.new(nil,nil,nil,o.result.interface)
+          end
+        end  
+      end  
+      return nil
+      #}}}
+    end
+
+    def check_message(params,headers,message)
+      description
+      declaration
+      #{{{
+      return true if message.class == Riddl::Wrapper::Description::Star
+      return true if message.nil? && params == []
+      mp = MessageParser.new(params,headers)
+      mp.check(message,true)
+      #}}}
+    end
+
+    def validate!
+      #{{{
+      if @is_description
+        xval = @doc.validate_against(XML::Smart.open_unprotected(DESCRIPTION_FILE))
+        xchk = ResourceChecker.new(@doc).check
+        puts xchk.join("\n") unless xchk.empty?
+        return xval && xchk.empty?
+      end
+      if @is_declaration
+        xval = @doc.validate_against(XML::Smart.open_unprotected(DECLARATION_FILE))
+        xchk = LayerChecker.new(@doc).check
+        puts xchk.join("\n") unless xchk.empty?
+        return xval && xchk.empty?
+      end
+      nil
+      #}}}
+    end
+
+    def load_necessary_handlers!
+      #{{{
+      @doc.find("//des:parameter/@handler").map{|h|h.to_s}.uniq.each do |h|
+        if File.exists?(File.dirname(__FILE__) + '/handlers/' + File.basename(h) + ".rb")
+          require File.expand_path(File.dirname(__FILE__) + '/handlers/' + File.basename(h))
+        end
+      end
+      #}}}
+    end
+    def load_necessary_roles!
+      #{{{
+      @doc.find("//des:resource/@role").map{|h|h.to_s}.uniq.each do |h|
+        h = Protocols::HTTP::Generator::escape(h)
+        if File.exists?(File.dirname(__FILE__) + '/roles/' + h + '.rb')
+          require File.expand_path(File.dirname(__FILE__) + '/roles/' + h)
+        end
+      end
+      #}}}
+    end
+
+    def paths
+      #{{{
+      description
+      declaration
+      tmp = []
+      tmp = @description.paths if @is_description 
+      tmp = @declaration.paths if @is_declaration
+      tmp.map do |t|
+        [t[0],Regexp.new("^" + t[0].gsub(/\{\}/,"[^/]+") + (t[1] ? '\/?' : '\/?$'))]
+      end
+      #}}}
+    end
+
+    class IOMessages
+      #{{{
+      def initialize(min,mout,route=nil,interface=nil)
+       @in = min
+       @out = mout
+       @route = route
+       @interface = interface
+      end
+      def route?
+        !(route.nil? || route.empty?)
+      end
+      attr_reader :in, :out, :route, :interface
+      #}}}
+    end
+    
+    def declaration?; @is_declaration; end
+    def description?; @is_description; end
+  end
+end

data/lib/riddl/wrapper/declaration.rb

@@ -0,0 +1,103 @@
+require File.expand_path(File.dirname(__FILE__) + '/description')
+require File.expand_path(File.dirname(__FILE__) + '/declaration/tile')
+require File.expand_path(File.dirname(__FILE__) + '/declaration/facade')
+require File.expand_path(File.dirname(__FILE__) + '/declaration/interface')
+
+module Riddl
+  class Wrapper
+    class Declaration < WrapperUtils
+        
+      def get_resource(path)
+        get_resource_deep(path,@facade.resource)
+      end  
+      def paths
+        rpaths(@facade.resource,'')
+      end
+      
+      def description_xml
+        @facade.description_xml
+      end
+
+      def description
+        Riddl::Wrapper.new(@facade.description_xml)
+      end
+
+      def visualize_tiles_and_layers
+        #{{{
+        @tiles.each_with_index do |til,index|
+          puts "### Tile #{index} " + ("#" * 60)
+          til.visualize :layers
+        end
+        #}}}
+      end
+      def visualize_tiles_and_compositions
+        #{{{
+        @tiles.each_with_index do |til,index|
+          puts "### Tile #{index} " + ("#" * 60)
+          til.visualize :composition
+        end
+        #}}}
+      end
+      def visualize_facade(res=@facade.resource,what='')
+        #{{{
+          what += res.path
+          puts what
+          res.composition.each do |k,v|
+            puts "  #{k.to_s.upcase}:"
+            v.each do |r|
+              puts "    #{r.result.class.name.gsub(/[^\:]+::/,'')}: #{r.result.visualize}"
+              r.route.each do |ritem|
+                puts "      #{ritem.class.name.gsub(/[^\:]+::/,'')}: #{ritem.visualize}"
+              end unless r.route.nil?
+            end
+          end
+          res.resources.each do |key,r|
+            visualize_facade(r,what + (what == '/' ? ''  : '/'))
+          end
+        #}}}
+      end
+
+      def initialize(riddl)
+        @facade = Riddl::Wrapper::Declaration::Facade.new
+        #{{{
+        ### create single tiles
+        @tiles = []
+        @interfaces = {}
+        riddl.find("/dec:declaration/dec:interface").each do |int|
+          @interfaces[int.attributes['name']] = [int.attributes['location'],int.find("des:description").first]
+        end
+        riddl.find("/dec:declaration/dec:facade/dec:tile").each do |tile|
+          @tiles << (til = Tile.new)
+          res = til.base_path(tile.attributes['path'] || '/')
+          # res.clean! # for overlapping tiles, each tile gets an empty path TODO
+          tile.find("dec:layer").each_with_index do |layer,index|
+            apply_to = layer.find("dec:apply-to")
+            block = layer.find("dec:block")
+
+            lname = layer.attributes['name']
+            lpath, des = @interfaces[lname]
+            desres = des.find("des:resource").first
+            if apply_to.empty?
+              int = Interface.new(lname,"/",lpath,"/",des)
+              rec = desres.attributes['recursive']
+              til.add_description(des,desres,"/",index,int,block,rec)
+            else
+              apply_to.each do |at|
+                int = Interface.new(lname,at.to_s,lpath,"/",des)
+                til.add_description(des,desres,at.to_s,index,int,block)
+              end
+            end
+          end
+          til.compose!
+        end
+
+        ### merge tiles into a facade
+        @tiles.each do |til|
+          @facade.merge_tiles(til.resource)
+        end
+        #}}}
+      end
+
+    end
+  end
+end

data/lib/riddl/wrapper/declaration/facade.rb

@@ -0,0 +1,94 @@
+module Riddl
+  class Wrapper
+    class Declaration < WrapperUtils
+
+      class Facade
+        def initialize
+          @resource = Riddl::Wrapper::Description::Resource.new("/")
+        end
+
+        def description_xml
+          #{{{
+          result = ""
+          messages = {}
+          names = []
+          messages_result = ""
+          description_result = ""
+          description_xml_priv(result,messages,0)
+          messages.each do |hash,mess|
+            t = mess.content.dup
+            name = mess.name
+            name += '_' while names.include?(name)
+            t.root.attributes['name'] = name
+            messages_result << t.root.dump + "\n"
+          end
+          XML::Smart.string("<description #{Riddl::Wrapper::COMMON}>\n\n" + description_result + messages_result.gsub(/^/,'  ') + "\n" + result + "\n</description>").to_s
+          #}}}
+        end
+        def description_xml_priv(result,messages,level,res=@resource)
+          #{{{
+          s = "  " * (level + 1)
+          t = "  " * (level + 2)
+          result << s + "<resource#{res.path != '/' && res.path != '{}' ? " relative=\"#{res.path}\"" : ''}#{res.recursive ? " recursive=\"true\"" : ''}>\n"
+          res.composition.each do |k,v|
+            v.each do |m|
+              m = m.result
+              if %w{get post put delete websocket}.include?(k)
+                result << t + "<#{k} "
+              else
+                result << t + "<request method=\"#{k}\" "
+              end  
+              case m
+                when Riddl::Wrapper::Description::RequestInOut
+                  messages[m.in.hash] ||= m.in
+                  result << "in=\"#{messages[m.in.hash].name}\""
+                  unless m.out.nil?
+                    messages[m.out.hash] ||= m.out
+                    result << " out=\"#{messages[m.out.hash].name}\""
+                  end  
+                when Riddl::Wrapper::Description::RequestStarOut
+                  result << "in=\"*\""
+                  unless m.out.nil?
+                    messages[m.out.hash] ||= m.out
+                    result << " out=\"#{messages[m.out.hash].name}\""
+                  end  
+                when Riddl::Wrapper::Description::RequestPass
+                  messages[m.pass.hash] ||= m.pass
+                  result << "pass=\"#{messages[m.pass.hash].name}\""
+                when Riddl::Wrapper::Description::RequestTransformation
+                  messages[m.trans.hash] ||= m.trans
+                  result << "transformation=\"#{messages[m.trans.hash].name}\""
+              end  
+              result << "/>\n"
+            end  
+          end
+          res.resources.each do |k,v|
+            description_xml_priv(result,messages,level+1,v)
+          end
+          ""
+          result << s + "</resource>\n"
+          #}}}
+        end
+        private :description_xml_priv
+      
+        def merge_tiles(res,fac=@resource)
+          #{{{
+          res.composition.each do |method,s|
+            fac.composition[method] ||= []
+            fac.composition[method] += s
+          end  
+          res.resources.each do |path,r|
+            unless fac.resources.has_key?(path)
+              fac.resources[path] = Riddl::Wrapper::Description::Resource.new(path,r.recursive)
+            end  
+            merge_tiles(r,fac.resources[path])
+          end
+          #}}}
+        end
+
+        attr_reader :resource
+      end
+
+    end
+  end
+end