soap5r 2.0.0

data/lib/wsdl/soap/mappingRegistryCreatorSupport.rb

@@ -0,0 +1,377 @@
+# encoding: ASCII-8BIT
+# WSDL4R - Creating MappingRegistry support.
+# Copyright (C) 2000-2007  NAKAMURA, Hiroshi <nahi@ruby-lang.org>.
+
+# This program is copyrighted free software by NAKAMURA, Hiroshi.  You can
+# redistribute it and/or modify it under the same terms of Ruby's license;
+# either the dual license version in 2003, or any later version.
+
+
+require 'wsdl/soap/classDefCreatorSupport'
+
+
+module WSDL
+module SOAP
+
+
+# requires @defined_const = {}, @dump_with_inner, @modulepath
+module MappingRegistryCreatorSupport
+  include ClassDefCreatorSupport
+  include XSD::CodeGen
+
+  def dump_with_inner
+    @dump_with_inner = []
+    @dump_with_inner.unshift(yield)
+    @dump_with_inner.join("\n")
+  end
+
+  def dump_complextypedef(mpath, qname, typedef, as_element = nil, opt = {})
+    case typedef.compoundtype
+    when :TYPE_STRUCT, :TYPE_EMPTY
+      dump_complex_typemap(mpath, qname, typedef, as_element, opt)
+    when :TYPE_ARRAY
+      dump_array_typemap(mpath, qname, typedef, as_element, opt)
+    when :TYPE_SIMPLE
+      dump_simple_typemap(mpath, qname, typedef, as_element, opt)
+    when :TYPE_MAP
+      # mapped as a general Hash
+      nil
+    else
+      raise RuntimeError.new(
+        "unknown kind of complexContent: #{typedef.compoundtype}")
+    end
+  end
+
+  def dump_array_typemap(mpath, qname, typedef, as_element, opt)
+    if typedef.find_soapenc_arytype
+      if opt[:encoded]
+        dump_encoded_array_typemap(mpath, qname, typedef, as_element, opt)
+      end
+    else
+      dump_literal_array_typemap(mpath, qname, typedef, as_element, opt)
+    end
+  end
+
+  def dump_complex_typemap(mpath, qname, typedef, as_element, opt)
+    var = {}
+    define_dump_class(var, mpath, qname, typedef, as_element, opt)
+    schema_ns = (var[:schema_name] || var[:schema_type]).namespace
+    if var[:schema_type] and typedef.base
+      var[:schema_basetype] = typedef.base
+    end
+    parentmodule = var[:class]
+    parsed_element =
+      parse_elements(typedef.elements, qname.namespace, parentmodule, opt)
+    if typedef.choice?
+      parsed_element.unshift(:choice)
+    end
+    var[:schema_element] = dump_schema_element_definition(parsed_element, 2)
+    unless typedef.attributes.empty?
+      var[:schema_attribute] = define_attribute(typedef.attributes)
+    end
+    assign_const(schema_ns, 'Ns')
+    dump_entry(@varname, var)
+  end
+
+  def dump_simple_typemap(mpath, qname, typedef, as_element, opt)
+    var = {}
+    define_dump_class(var, mpath, qname, typedef, as_element, opt)
+    schema_ns = (var[:schema_name] || var[:schema_type]).namespace
+    unless typedef.attributes.empty?
+      var[:schema_attribute] = define_attribute(typedef.attributes)
+    end
+    assign_const(schema_ns, 'Ns')
+    dump_entry(@varname, var)
+  end
+
+  def dump_schema_element_definition(definition, indent = 0)
+    return '[]' if definition.empty?
+    sp = ' ' * indent
+    if definition[0] == :choice
+      definition.shift
+      "[ :choice,\n" +
+        dump_schema_element(definition, indent + 2) + "\n" + sp + "]"
+    elsif definition[0].is_a?(::Array)
+      "[\n" +
+        dump_schema_element(definition, indent + 2) + "\n" + sp + "]"
+    else
+      varname, name, type, occurrence = definition
+      '[' + [
+        varname.dump,
+        dump_type(name, type),
+        dump_occurrence(occurrence)
+      ].compact.join(', ') + ']'
+    end
+  end
+
+  def dump_schema_element(schema_element, indent = 0)
+    sp = ' ' * indent
+    delimiter = ",\n" + sp
+    sp + schema_element.collect { |definition|
+      dump_schema_element_definition(definition, indent)
+    }.join(delimiter)
+  end
+
+  def dump_type(name, type)
+    if name
+      assign_const(name.namespace, 'Ns')
+      '[' + ndq(type) + ', ' + dqname(name) + ']'
+    else
+      ndq(type)
+    end
+  end
+
+  def dump_occurrence(occurrence)
+    if occurrence and occurrence != [1, 1] # default
+      minoccurs, maxoccurs = occurrence
+      maxoccurs ||= 'nil'
+      "[#{minoccurs}, #{maxoccurs}]"
+    end
+  end
+
+  def parse_elements(elements, base_namespace, mpath, opt)
+    schema_element = []
+    any = false
+    elements.each do |element|
+      case element
+      when XMLSchema::Any
+        # only 1 <any/> is allowed for now.
+        raise RuntimeError.new("duplicated 'any'") if any
+        any = true
+        varname = 'any' # not used
+        eleqname = XSD::AnyTypeName
+        type = nil
+        occurrence = nil
+        schema_element << [varname, eleqname, type, occurrence]
+      when XMLSchema::Element
+        next if element.ref == SchemaName
+        typebase = @modulepath
+        if element.anonymous_type?
+          child_opt = {
+            :qualified => (element.elementform == 'qualified'),
+            :is_anonymous => true
+          }
+          @dump_with_inner << dump_complextypedef(mpath, element.name, element.local_complextype, nil, child_opt)
+          typebase = mpath
+        end
+        type = create_type_name(typebase, element)
+        name = name_element(element).name
+        varname = safevarname(name)
+        if element.map_as_array?
+          if type
+            type += '[]'
+          else
+            type = '[]'
+          end
+        end
+        # nil means @@schema_ns + varname
+        eleqname = element.name || element.ref
+        if eleqname && varname == name && eleqname.namespace == base_namespace
+          eleqname = nil
+        end
+        occurrence = [element.minoccurs, element.maxoccurs]
+        schema_element << [varname, eleqname, type, occurrence]
+      when WSDL::XMLSchema::Sequence
+        child_schema_element =
+          parse_elements(element.elements, base_namespace, mpath, opt)
+        schema_element << child_schema_element
+      when WSDL::XMLSchema::Choice
+        child_schema_element =
+          parse_elements(element.elements, base_namespace, mpath, opt)
+        if !element.map_as_array?
+          # choice + maxOccurs="unbounded" is treated just as 'all' now.
+          child_schema_element.unshift(:choice)
+        end
+        schema_element << child_schema_element
+      when WSDL::XMLSchema::Group
+        if element.content.nil?
+          warn("no group definition found: #{element}")
+          next
+        end
+        child_schema_element =
+          parse_elements(element.content.elements, base_namespace, mpath, opt)
+        schema_element.concat(child_schema_element)
+      else
+        raise RuntimeError.new("unknown type: #{element}")
+      end
+    end
+    schema_element
+  end
+
+  def define_attribute(attributes)
+    schema_attribute = []
+    attributes.each do |attribute|
+      name = name_attribute(attribute)
+      if klass = attribute_basetype(attribute)
+        type = klass.name
+      else
+        warn("unresolved attribute type #{attribute.type} for #{name}")
+        type = nil
+      end
+      schema_attribute << [name, type]
+    end
+    "{\n    " +
+      schema_attribute.collect { |name, type|
+        assign_const(name.namespace, 'Ns')
+        dqname(name) + ' => ' + ndq(type)
+      }.join(",\n    ") +
+    "\n  }"
+  end
+
+  def dump_entry(regname, var)
+    "#{regname}.register(\n  " +
+      [
+        dump_entry_item(var, :class),
+        dump_entry_item(var, :soap_class),
+        dump_entry_item(var, :schema_name, :qname),
+        dump_entry_item(var, :schema_type, :qname),
+        dump_entry_item(var, :is_anonymous),
+        dump_entry_item(var, :schema_basetype, :qname),
+        dump_entry_item(var, :schema_qualified),
+        dump_entry_item(var, :schema_element),
+        dump_entry_item(var, :schema_attribute)
+      ].compact.join(",\n  ") +
+    "\n)\n"
+  end
+
+  def dump_entry_item(var, key, dump_type = :none)
+    if var.key?(key)
+      case dump_type
+      when :none
+        ":#{key} => #{var[key]}"
+      when :string
+        if @defined_const.key?(var[key])
+          ":#{key} => #{@defined_const[var[key]]}"
+        else
+          ":#{key} => #{ndq(var[key])}"
+        end
+      when :qname
+        qname = var[key]
+        if @defined_const.key?(qname.namespace)
+          ns = @defined_const[qname.namespace]
+        else
+          ns = ndq(qname.namespace)
+        end
+        ":#{key} => XSD::QName.new(#{ns}, #{ndq(qname.name)})"
+      else
+        raise "Unknown dump type: #{dump_type}"
+      end
+    end
+  end
+
+  def dump_simpletypedef(mpath, qname, simpletype, as_element = nil, opt = {})
+    if simpletype.restriction
+      dump_simpletypedef_restriction(mpath, qname, simpletype, as_element, opt)
+    elsif simpletype.list
+      dump_simpletypedef_list(mpath, qname, simpletype, as_element, opt)
+    elsif simpletype.union
+      dump_simpletypedef_union(mpath, qname, simpletype, as_element, opt)
+    else
+      raise RuntimeError.new("unknown kind of simpletype: #{simpletype}")
+    end
+  end
+
+  def dump_simpletypedef_restriction(mpath, qname, typedef, as_element, opt)
+    restriction = typedef.restriction
+    unless restriction.enumeration?
+      # not supported.  minlength?
+      return nil
+    end
+    var = {}
+    define_dump_class(var, mpath, qname, typedef, as_element, opt)
+    schema_ns = (var[:schema_name] || var[:schema_type]).namespace
+    assign_const(schema_ns, 'Ns')
+    dump_entry(@varname, var)
+  end
+
+  def dump_simpletypedef_list(mpath, qname, typedef, as_element, opt)
+    nil
+  end
+
+  def dump_simpletypedef_union(mpath, qname, typedef, as_element, opt)
+    nil
+  end
+
+  DEFAULT_ITEM_NAME = XSD::QName.new(nil, 'item')
+
+  def dump_literal_array_typemap(mpath, qname, typedef, as_element, opt)
+    var = {}
+    define_dump_class(var, mpath, qname, typedef, as_element, opt)
+    schema_ns = (var[:schema_name] || var[:schema_type]).namespace
+    parsed_element =
+      parse_elements(typedef.elements, qname.namespace, var[:class], opt)
+    if parsed_element.empty?
+      parsed_element = [create_array_element_definition(typedef, mpath)]
+    end
+    var[:schema_element] = dump_schema_element_definition(parsed_element, 2)
+    assign_const(schema_ns, 'Ns')
+    dump_entry(@varname, var)
+  end
+
+  def dump_encoded_array_typemap(mpath, qname, typedef, as_element, opt)
+    arytype = typedef.find_arytype || XSD::AnyTypeName
+    type = XSD::QName.new(arytype.namespace, arytype.name.sub(/\[(?:,)*\]$/, ''))
+    return <<__EOD__
+#{@varname}.set(
+  #{mapped_class_name(qname, mpath)},
+  ::SOAP::SOAPArray,
+  ::SOAP::Mapping::EncodedRegistry::TypedArrayFactory,
+  { :type => #{dqname(type)} }
+)
+__EOD__
+  end
+
+  # used when "soapenc:arrayType" definition
+  def create_array_element_definition(typedef, mpath)
+    child_type = typedef.child_type
+    child_element = typedef.find_aryelement
+    if child_type == XSD::AnyTypeName
+      type = nil
+    elsif child_element
+      if klass = element_basetype(child_element)
+        type = klass.name
+      else
+        typename = child_element.type || child_element.name
+        type = mapped_class_name(typename, mpath)
+      end
+    elsif child_type
+      type = mapped_class_name(child_type, mpath)
+    else
+      type = nil
+    end
+    occurrence = [0, nil]
+    if child_element and child_element.name
+      if child_element.map_as_array?
+        type << '[]' if type
+        occurrence = [child_element.minoccurs, child_element.maxoccurs]
+      end
+      child_element_name = child_element.name
+    else
+      child_element_name = DEFAULT_ITEM_NAME
+    end
+    [child_element_name.name, child_element_name, type, occurrence]
+  end
+
+  def define_dump_class(var, mpath, qname, typedef, as_element, opt)
+    var[:class] = mapped_class_name(qname, mpath)
+    if as_element
+      var[:schema_name] = as_element
+      schema_ns = as_element.namespace
+    elsif typedef.name.nil?
+      var[:schema_name] = qname
+      schema_ns = qname.namespace
+    else
+      var[:schema_type] = qname
+      schema_ns = qname.namespace
+    end
+    var[:is_anonymous] = opt[:is_anonymous] if opt.key?(:is_anonymous)
+    # true, false, or nil
+    if opt.key?(:qualified)
+      var[:schema_qualified] = opt[:qualified].to_s
+    end
+  end
+end
+
+
+end
+end

data/lib/wsdl/soap/methodDefCreator.rb

@@ -0,0 +1,200 @@
+# encoding: ASCII-8BIT
+# WSDL4R - Creating method definition from WSDL
+# Copyright (C) 2000-2007  NAKAMURA, Hiroshi <nahi@ruby-lang.org>.
+
+# This program is copyrighted free software by NAKAMURA, Hiroshi.  You can
+# redistribute it and/or modify it under the same terms of Ruby's license;
+# either the dual license version in 2003, or any later version.
+
+
+require 'wsdl/info'
+require 'wsdl/soap/classDefCreatorSupport'
+require 'soap/rpc/element'
+require 'soap/rpc/methodDef'
+
+
+module WSDL
+module SOAP
+
+
+class MethodDefCreator
+  include ClassDefCreatorSupport
+
+  attr_reader :definitions
+  # TODO: should not export this kind of stateful information.
+  # will be rewwritten in 1.6.1
+  attr_reader :assigned_method
+
+  def initialize(definitions, name_creator, modulepath, defined_const)
+    @definitions = definitions
+    @name_creator = name_creator
+    @modulepath = modulepath
+    @simpletypes = @definitions.collect_simpletypes
+    @complextypes = @definitions.collect_complextypes
+    @elements = @definitions.collect_elements
+    @defined_const = defined_const
+    @assigned_method = {}
+  end
+
+  def dump(name)
+    methoddef = ""
+    porttype = @definitions.porttype(name)
+    binding = porttype.find_binding
+    if binding
+      create(binding.name).each do |mdef|
+        methoddef << ",\n" unless methoddef.empty?
+        methoddef << dump_method(mdef).chomp
+      end
+    end
+    methoddef
+  end
+
+  def create(bindingname)
+    binding = @definitions.binding(bindingname)
+    if binding
+      return binding.operations.collect { |op_bind|
+        next unless op_bind.soapoperation # not a SOAP operation binding
+        create_methoddef(op_bind)
+      }
+    end
+    nil
+  end
+
+private
+
+  def create_methoddef(op_bind)
+    op_info = op_bind.operation_info
+    name = assign_method_name(op_bind)
+    soapaction = op_info.boundid.soapaction
+    qname = op_bind.soapoperation_name
+    mdef = ::SOAP::RPC::MethodDef.new(name, soapaction, qname)
+    op_info.parts.each do |part|
+      if op_info.style == :rpc
+        mapped_class, qname = rpcdefinedtype(part)
+      else
+        mapped_class, qname = documentdefinedtype(part)
+      end
+      mdef.add_parameter(part.io_type, part.name, qname, mapped_class)
+    end
+    op_info.faults.each do |name, faultinfo|
+      faultclass = mapped_class_name(name, @modulepath)
+      mdef.faults[faultclass] = faultinfo
+    end
+    mdef.style = op_info.style
+    mdef.inputuse = op_info.inputuse
+    mdef.outputuse = op_info.outputuse
+    mdef
+  end
+
+  def dump_method(mdef)
+    style = mdef.style
+    inputuse = mdef.inputuse
+    outputuse = mdef.outputuse
+    paramstr = param2str(mdef.parameters)
+    if paramstr.empty?
+      paramstr = '[]'
+    else
+      paramstr = "[ " << paramstr.split(/\r?\n/).join("\n    ") << " ]"
+    end
+    definitions = <<__EOD__
+#{ndq(mdef.soapaction)},
+  #{dq(mdef.name)},
+  #{paramstr},
+  { :request_style =>  #{nsym(style)}, :request_use =>  #{nsym(inputuse)},
+    :response_style => #{nsym(style)}, :response_use => #{nsym(outputuse)},
+    :faults => #{mdef.faults.inspect} }
+__EOD__
+    if style == :rpc
+      assign_const(mdef.qname.namespace, 'Ns')
+      return <<__EOD__
+[ #{dqname(mdef.qname)},
+  #{definitions}]
+__EOD__
+    else
+      return <<__EOD__
+[ #{definitions}]
+__EOD__
+    end
+  end
+
+  def assign_method_name(op_bind)
+    method_name = safemethodname(op_bind.name)
+    i = 1 # starts from _2
+    while @assigned_method.value?(method_name)
+      i += 1
+      method_name = safemethodname("#{op_bind.name}_#{i}")
+    end
+    @assigned_method[op_bind.boundid] = method_name
+    method_name
+  end
+
+  def rpcdefinedtype(part)
+    if mapped = basetype_mapped_class(part.type)
+      return ['::' + mapped.name, nil]
+    elsif definedtype = @simpletypes[part.type]
+      return [nil, definedtype.name]
+    elsif definedtype = @elements[part.element]
+      return [nil, part.element]
+    elsif definedtype = @complextypes[part.type]
+      case definedtype.compoundtype
+      when :TYPE_STRUCT, :TYPE_EMPTY, :TYPE_ARRAY, :TYPE_SIMPLE
+        type = mapped_class_name(part.type, @modulepath)
+	return [type, part.type]
+      when :TYPE_MAP
+	return [Hash.name, part.type]
+      else
+	raise NotImplementedError.new("must not reach here: #{definedtype.compoundtype}")
+      end
+    elsif part.type == XSD::AnyTypeName
+      return [nil, nil]
+    else
+      raise RuntimeError.new("part: #{part.name} cannot be resolved")
+    end
+  end
+
+  def documentdefinedtype(part)
+    if mapped = basetype_mapped_class(part.type)
+      return ['::' + mapped.name, XSD::QName.new(nil, part.name)]
+    elsif definedtype = @simpletypes[part.type]
+      if definedtype.base
+        return ['::' + basetype_mapped_class(definedtype.base).name, XSD::QName.new(nil, part.name)]
+      else
+        raise RuntimeError.new("unsupported simpleType: #{definedtype}")
+      end
+    elsif definedtype = @elements[part.element]
+      return ['::SOAP::SOAPElement', part.element]
+    elsif definedtype = @complextypes[part.type]
+      return ['::SOAP::SOAPElement', part.type]
+    else
+      raise RuntimeError.new("part: #{part.name} cannot be resolved")
+    end
+  end
+
+  def param2str(params)
+    params.collect { |param|
+      mappingstr = mapping_info2str(param.mapped_class, param.qname)
+      "[:#{param.io_type.id2name}, #{dq(param.name)}, #{mappingstr}]"
+    }.join(",\n")
+  end
+
+  def mapping_info2str(mapped_class, qname)
+    if qname.nil?
+      "[#{ndq(mapped_class)}]" 
+    else
+      "[#{ndq(mapped_class)}, #{ndq(qname.namespace)}, #{dq(qname.name)}]" 
+    end
+  end
+
+  def ele2str(ele)
+    qualified = ele
+    if qualified
+      "true"
+    else
+      "false"
+    end
+  end
+end
+
+
+end
+end

data/lib/wsdl/soap/operation.rb

@@ -0,0 +1,113 @@
+# encoding: ASCII-8BIT
+# WSDL4R - WSDL SOAP operation definition.
+# Copyright (C) 2000-2007  NAKAMURA, Hiroshi <nahi@ruby-lang.org>.
+
+# This program is copyrighted free software by NAKAMURA, Hiroshi.  You can
+# redistribute it and/or modify it under the same terms of Ruby's license;
+# either the dual license version in 2003, or any later version.
+
+
+require 'wsdl/info'
+
+
+module WSDL
+module SOAP
+
+
+class Operation < Info
+  class ParamInfo
+    attr_reader :style
+    attr_reader :op_name
+    attr_reader :optype_name
+    attr_reader :encodingstyle
+    attr_reader :headerparts
+    attr_reader :bodyparts
+    attr_reader :faultpart
+    attr_reader :soapaction
+    
+    def initialize(style, use, encodingstyle, op_name, optype_name,
+        headerparts, bodyparts, faultpart, soapaction)
+      @style = style
+      @use = use
+      @encodingstyle = encodingstyle
+      @op_name = op_name
+      @optype_name = optype_name
+      @headerparts = headerparts
+      @bodyparts = bodyparts
+      @faultpart = faultpart
+      @soapaction = soapaction
+    end
+  end
+
+  attr_reader :soapaction
+  attr_reader :style
+
+  def initialize
+    super
+    @soapaction = nil
+    @style = nil
+  end
+
+  def parse_element(element)
+    nil
+  end
+
+  def parse_attr(attr, value)
+    case attr
+    when StyleAttrName
+      if ["document", "rpc"].include?(value.source)
+	@style = value.source.intern
+      else
+	raise Parser::AttributeConstraintError.new(
+          "Unexpected value #{ value }.")
+      end
+    when SOAPActionAttrName
+      @soapaction = value.source
+    else
+      nil
+    end
+  end
+
+  def operation_style
+    return @style if @style
+    if parent_binding.soapbinding
+      return parent_binding.soapbinding.style
+    end
+    nil
+  end
+
+private
+
+  def parent_binding
+    parent.parent
+  end
+
+  def create_param_info(name_info, param)
+    op_style = operation_style()
+    op_use = param.soapbody_use
+    op_encodingstyle = param.soapbody_encodingstyle
+    op_name = name_info.op_name
+    optype_name = name_info.optype_name
+    soapheader = param.soapheader
+    headerparts = soapheader.collect { |item| item.find_part }
+    soapbody = param.soapbody
+    if soapbody.namespace
+      op_name = XSD::QName.new(soapbody.namespace, op_name.name)
+    end
+    if soapbody.parts
+      target = soapbody.parts.split(/\s+/)
+      bodyparts = name_info.parts.find_all { |part|
+	target.include?(part.name)
+      }
+    else
+      bodyparts = name_info.parts
+    end
+    faultpart = nil
+    ParamInfo.new(op_style, op_use, op_encodingstyle, op_name, optype_name,
+      headerparts, bodyparts, faultpart, parent.soapaction)
+  end
+end
+
+
+end
+end