root/trunk/lib/soap/mapping/mapping.rb

# SOAP4R - Ruby type mapping utility.
# 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 'xsd/codegen/gensupport'
require 'soap/mapping/schemadefinition'


module SOAP


module Mapping
  RubyTypeNamespace = 'http://www.ruby-lang.org/xmlns/ruby/type/1.6'
  RubyTypeInstanceNamespace =
    'http://www.ruby-lang.org/xmlns/ruby/type-instance'
  RubyCustomTypeNamespace = 'http://www.ruby-lang.org/xmlns/ruby/type/custom'
  ApacheSOAPTypeNamespace = 'http://xml.apache.org/xml-soap'


  module TraverseSupport
    def mark_marshalled_obj(obj, soap_obj)
      raise if obj.nil?
      Thread.current[:SOAPMapping][:MarshalKey][obj.__id__] = soap_obj
    end

    def mark_unmarshalled_obj(node, obj)
      return if obj.nil?
      # node.id is not Object#id but SOAPReference#id
      Thread.current[:SOAPMapping][:MarshalKey][node.id] = obj
    end
  end


  EMPTY_OPT = {}.freeze
  def self.obj2soap(obj, registry = nil, type = nil, opt = EMPTY_OPT)
    registry ||= Mapping::DefaultRegistry
    soap_obj = nil
    protect_mapping(opt) do
      soap_obj = _obj2soap(obj, registry, type)
    end
    soap_obj
  end

  def self.objs2soap(objs, registry = nil, types = nil, opt = EMPTY_OPT)
    registry ||= Mapping::DefaultRegistry
    ary = []
    protect_mapping(opt) do
      0.upto(objs.length - 1) do |idx|
        type = types ? types[idx] : nil
        soap = _obj2soap(objs[idx], registry, type)
        ary << soap
      end
    end
    ary
  end

  def self.soap2obj(node, registry = nil, klass = nil, opt = EMPTY_OPT)
    registry ||= Mapping::DefaultRegistry
    obj = nil
    protect_mapping(opt) do
      obj = _soap2obj(node, registry, klass)
    end
    obj
  end

  def self.ary2soap(ary, type_ns = XSD::Namespace, typename = XSD::AnyTypeLiteral, registry = nil, opt = EMPTY_OPT)
    registry ||= Mapping::DefaultRegistry
    type = XSD::QName.new(type_ns, typename)
    soap_ary = SOAPArray.new(ValueArrayName, 1, type)
    protect_mapping(opt) do
      ary.each do |ele|
        soap_ary.add(_obj2soap(ele, registry, type))
      end
    end
    soap_ary
  end

  def self.ary2md(ary, rank, type_ns = XSD::Namespace, typename = XSD::AnyTypeLiteral, registry = nil, opt = EMPTY_OPT)
    registry ||= Mapping::DefaultRegistry
    type = XSD::QName.new(type_ns, typename)
    md_ary = SOAPArray.new(ValueArrayName, rank, type)
    protect_mapping(opt) do
      add_md_ary(md_ary, ary, [], registry)
    end
    md_ary
  end

  def self.fault2exception(fault, registry = nil)
    registry ||= Mapping::DefaultRegistry
    detail = ""
    if fault.detail
      begin
        fault.detail.type ||= XSD::QName::EMPTY
        detail = soap2obj(fault.detail, registry) || ""
      rescue MappingError
        detail = fault.detail
      end
    end
    if detail.is_a?(Mapping::SOAPException)
      begin
        e = detail.to_e
        remote_backtrace = e.backtrace
        e.set_backtrace(nil)
        raise e # ruby sets current caller as local backtrace of e => e2.
      rescue Exception => e
        e.set_backtrace(remote_backtrace + e.backtrace[1..-1])
        raise
      end
    else
      fault.detail = detail
      fault.set_backtrace(
        if detail.is_a?(Array)
          detail
        else
          [detail.to_s]
        end
      )
      raise
    end
  end

  def self._obj2soap(obj, registry, type = nil)
    if obj.respond_to?(:to_xmlpart)
      SOAPRawData.new(obj)
    elsif defined?(::REXML) and obj.is_a?(::REXML::Element)
      SOAPRawData.new(SOAPREXMLElementWrap.new(obj))
    elsif referent = Thread.current[:SOAPMapping][:MarshalKey][obj.__id__] and
        !Thread.current[:SOAPMapping][:NoReference]
      SOAPReference.new(referent)
    elsif registry
      registry.obj2soap(obj, type)
    else
      raise MappingError.new("no mapping registry given")
    end
  end

  def self._soap2obj(node, registry, klass = nil)
    if node.nil?
      return nil
    elsif node.is_a?(SOAPReference)
      target = node.__getobj__
      # target.id is not Object#id but SOAPReference#id
      if referent = Thread.current[:SOAPMapping][:MarshalKey][target.id] and
          !Thread.current[:SOAPMapping][:NoReference]
        return referent
      else
        return _soap2obj(target, registry, klass)
      end
    end
    return registry.soap2obj(node, klass)
  end

  def self.create_empty_object(klass)
    klass.allocate
  end

  # Allow only (Letter | '_') (Letter | Digit | '-' | '_')* here.
  # Caution: '.' is not allowed here.
  # To follow XML spec., it should be NCName.
  #   (denied chars) => .[0-F][0-F]
  #   ex. a.b => a.2eb
  #
  def self.name2elename(name)
    name.gsub(/([^a-zA-Z0-9:_\-]+)/n) {
      '.' << $1.unpack('H2' * $1.size).join('.')
    }.gsub(/::/n, '..')
  end

  def self.elename2name(name)
    name.gsub(/\.\./n, '::').gsub(/((?:\.[0-9a-fA-F]{2})+)/n) {
      [$1.delete('.')].pack('H*')
    }
  end

  def self.const_from_name(name, lenient = false)
    const = ::Object
    name.sub(/\A::/, '').split('::').each do |const_str|
      if /\A[A-Z]/ =~ const_str
        begin
          if const.const_defined?(const_str)
            const = const.const_get(const_str)
            next
          end
        rescue NameError
        end
      end
      if lenient
        const_str = Mapping.safeconstname(const_str)
        if const.const_defined?(const_str)
          const = const.const_get(const_str)
          next
        end
      end
      return nil
    end
    const
  end

  def self.class_from_name(name, lenient = false)
    unless lenient
      const = const_from_name_nonlenient(name)
    else
      const = const_from_name(name, true)
    end
    if const.is_a?(::Class)
      const
    else
      nil
    end
  end

  def self.module_from_name(name, lenient = false)
    unless lenient
      const = const_from_name_nonlenient(name)
    else
      const = const_from_name(name, true)
    end
    if const.is_a?(::Module)
      const
    else
      nil
    end
  end

  def self.const_from_name_nonlenient(name)
    if Thread.current[:SOAPMapping]
      Thread.current[:SOAPMapping][:ConstFromName][name] ||=
        const_from_name(name)
    else
      const_from_name(name)
    end
  end

  def self.class2qname(klass)
    name = schema_type_definition(klass)
    namespace = schema_ns_definition(klass)
    XSD::QName.new(namespace, name)
  end

  def self.class2element(klass)
    name = schema_type_definition(klass) ||
      Mapping.name2elename(klass.name)
    namespace = schema_ns_definition(klass) || RubyCustomTypeNamespace
    XSD::QName.new(namespace, name)
  end

  def self.obj2element(obj)
    name = namespace = nil
    ivars = obj.instance_variables
    if ivars.include?('@schema_type')
      name = obj.instance_variable_get('@schema_type')
    end
    if ivars.include?('@schema_ns')
      namespace = obj.instance_variable_get('@schema_ns')
    end
    if !name or !namespace
      class2qname(obj.class)
    else
      XSD::QName.new(namespace, name)
    end
  end

  def self.to_qname(obj, ns = nil)
    if obj.is_a?(XSD::QName)
      obj
    else
      XSD::QName.new(ns, obj)
    end
  end

  def self.define_singleton_method(obj, name, &block)
    sclass = (class << obj; self; end)
    sclass.class_eval {
      define_method(name, &block)
    }
  end

  def self.get_attributes(obj)
    if obj.is_a?(::Hash)
      obj
    else
      rs = {}
      obj.instance_variables.each do |ele|
        rs[ele.sub(/^@/, '')] = obj.instance_variable_get(ele)
      end
      rs
    end
  end

  EMPTY_ATTRIBUTES = {}.freeze
  def self.get_attributes_for_any(obj)
    if obj.respond_to?(:__xmlele_any)
      obj.__xmlele_any || EMPTY_ATTRIBUTES
    else
      get_attributes(obj)
    end
  end

  def self.get_attribute(obj, attr_name)
    case obj
    when ::SOAP::Mapping::Object
      return obj[attr_name]
    when ::Hash
      return obj[attr_name] || obj[attr_name.intern]
    else
      if obj.respond_to?(attr_name)
        return obj.__send__(attr_name)
      end
      iv = obj.instance_variables
      name = Mapping.safevarname(attr_name)
      if iv.include?("@#{name}")
        return obj.instance_variable_get("@#{name}")
      elsif iv.include?("@#{attr_name}")
        return obj.instance_variable_get("@#{attr_name}")
      end
      if obj.respond_to?(name)
        return obj.__send__(name)
      end
      nil
    end
  end

  def self.set_attributes(obj, values)
    case obj
    when ::SOAP::Mapping::Object
      values.each do |attr_name, value|
        obj.__add_xmlele_value(attr_name, value)
      end
    else
      values.each do |attr_name, value|
        # untaint depends GenSupport.safevarname
        name = Mapping.safevarname(attr_name).untaint
        setter = name + "="
        if obj.respond_to?(setter)
          obj.__send__(setter, value)
        else
          obj.instance_variable_set('@' + name, value)
          begin
            unless obj.respond_to?(name)
              obj.instance_eval <<-EOS
                def #{name}
                  @#{name}
                end
              EOS
            end
            unless self.respond_to?(name + "=")
              obj.instance_eval <<-EOS
                def #{name}=(value)
                  @#{name} = value
                end
              EOS
            end
          rescue TypeError
            # singleton class may not exist (e.g. Float)
          end
        end
      end
    end
  end

  def self.safeconstname(name)
    Thread.current[:SOAPMapping][:SafeConstName][name] ||=
      XSD::CodeGen::GenSupport.safeconstname(name)
  end

  def self.safemethodname(name)
    Thread.current[:SOAPMapping][:SafeMethodName][name] ||=
      XSD::CodeGen::GenSupport.safemethodname(name)
  end

  def self.safevarname(name)
    Thread.current[:SOAPMapping][:SafeVarName][name] ||=
      XSD::CodeGen::GenSupport.safevarname(name)
  end

  def self.root_type_hint
    Thread.current[:SOAPMapping][:RootTypeHint]
  end

  def self.reset_root_type_hint
    Thread.current[:SOAPMapping][:RootTypeHint] = false
  end

  def self.external_ces
    Thread.current[:SOAPMapping][:ExternalCES]
  end

  def self.schema_ns_definition(klass)
    class_schema_variable(:schema_ns, klass)
  end

  def self.schema_name_definition(klass)
    class_schema_variable(:schema_name, klass)
  end

  def self.schema_type_definition(klass)
    class_schema_variable(:schema_type, klass)
  end

  def self.schema_qualified_definition(klass)
    class_schema_variable(:schema_qualified, klass)
  end

  def self.schema_element_definition(klass)
    class_schema_variable(:schema_element, klass)
  end

  def self.schema_attribute_definition(klass)
    class_schema_variable(:schema_attribute, klass)
  end

  def self.schema_definition_classdef(klass)
    if Thread.current[:SOAPMapping][:SchemaDefinition].key?(klass)
      return Thread.current[:SOAPMapping][:SchemaDefinition][klass]
    end
    schema_ns = schema_ns_definition(klass)
    schema_name = schema_name_definition(klass)
    schema_type = schema_type_definition(klass)
    qualified = schema_qualified_definition(klass)
    elements = schema_element_definition(klass)
    attributes = schema_attribute_definition(klass)
    return nil if schema_name.nil? and schema_type.nil?
    schema_name = Mapping.to_qname(schema_name, schema_ns) if schema_name
    schema_type = Mapping.to_qname(schema_type, schema_ns) if schema_type
    definition = create_schema_definition(klass,
      :schema_name => schema_name,
      :schema_type => schema_type,
      :is_anonymous => false,
      :schema_qualified => qualified,
      :schema_element => elements,
      :schema_attribute => attributes
    )
    Thread.current[:SOAPMapping][:SchemaDefinition][klass] = definition
    definition
  end

  def self.create_schema_definition(klass, definition)
    schema_ns = definition[:schema_ns]
    schema_name = definition[:schema_name]
    schema_type = definition[:schema_type]
    is_anonymous = definition[:is_anonymous]
    schema_basetype = definition[:schema_basetype]
    schema_qualified = definition[:schema_qualified]
    schema_element = definition[:schema_element]
    schema_attributes = definition[:schema_attribute]
    definition = SchemaDefinition.new(klass, schema_name, schema_type, is_anonymous, schema_qualified)
    definition.basetype = schema_basetype
    definition.attributes = schema_attributes
    if schema_element
      if schema_element.respond_to?(:is_concrete_definition) and
          schema_element.is_concrete_definition
        definition.elements = schema_element
      else
        default_ns = schema_name.namespace if schema_name
        default_ns ||= schema_type.namespace if schema_type
        definition.elements = parse_schema_definition(schema_element, default_ns)
        if klass < ::Array
          definition.elements.set_array
        end
      end
    end
    definition
  end

  # returns SchemaComplexTypeDefinition
  def self.parse_schema_definition(schema_element, default_ns)
    definition = nil
    if schema_element[0] == :choice
      schema_element.shift
      definition = SchemaChoiceDefinition.new
    else
      definition = SchemaSequenceDefinition.new
    end
    schema_element.each do |ele|
      element_definition = parse_schema_element_definition(ele, default_ns)
      definition << element_definition
    end
    definition
  end

  # returns SchemaElementDefinition
  def self.parse_schema_element_definition(schema_element, default_ns)
    if schema_element[0] == :choice
      parse_schema_definition(schema_element, default_ns)
    elsif schema_element[0].is_a?(Array)
      parse_schema_definition(schema_element, default_ns)
    else
      varname, info, occurrence = schema_element
      mapped_class_str, elename = info
      if occurrence
        minoccurs, maxoccurs = occurrence
      else
        minoccurs, maxoccurs = 1, 1
      end
      as_any = as_array = false
      if /\[\]$/ =~ mapped_class_str
        mapped_class_str = mapped_class_str.sub(/\[\]$/, '')
        if mapped_class_str.empty?
          mapped_class_str = nil
        end
        as_array = true
      end
      if mapped_class_str
        mapped_class = Mapping.class_from_name(mapped_class_str)
        if mapped_class.nil?
          warn("cannot find mapped class: #{mapped_class_str}")
        end
      end
      if elename == XSD::AnyTypeName
        as_any = true
      elsif elename.nil?
        elename = XSD::QName.new(default_ns, varname)
      end
      SchemaElementDefinition.new(
        varname, mapped_class, elename, minoccurs, maxoccurs, as_any, as_array)
    end
  end

  class << Mapping
  public

    def protect_threadvars(*symbols)
      backup = {}
      begin
        symbols.each do |sym|
          backup[sym] = Thread.current[sym]
        end
        yield
      ensure
        symbols.each do |sym|
          Thread.current[sym] = backup[sym]
        end
      end
    end

  private

    def class_schema_variable(sym, klass)
      var = "@@#{sym}"
      klass.class_variables.include?(var) ? klass.class_eval(var) : nil
    end

    def protect_mapping(opt)
      protect_threadvars(:SOAPMapping) do
        data = Thread.current[:SOAPMapping] = {}
        data[:MarshalKey] = {}
        data[:ExternalCES] = opt[:external_ces] || XSD::Charset.encoding
        data[:NoReference] = opt[:no_reference]
        data[:RootTypeHint] = opt[:root_type_hint]
        data[:SchemaDefinition] = {}
        data[:SafeConstName] = {}
        data[:SafeMethodName] = {}
        data[:SafeVarName] = {}
        data[:ConstFromName] = {}
        yield
      end
    end

    def add_md_ary(md_ary, ary, indices, registry)
      for idx in 0..(ary.size - 1)
        if ary[idx].is_a?(Array)
          add_md_ary(md_ary, ary[idx], indices + [idx], registry)
        else
          md_ary[*(indices + [idx])] = _obj2soap(ary[idx], registry)
        end
      end
    end
  end
end


end