Class: SOAP::SOAPGenerator

Inherits:
Object show all
Includes:
SOAP
Defined in:
lib/soap/generator.rb

Overview

CAUTION: MT-unsafe

Defined Under Namespace

Classes: FormatEncodeError

Constant Summary collapse

EncodeMap = 
{
  '&' => '&',
  '<' => '&lt;',
  '>' => '&gt;',
  '"' => '&quot;',
  '\'' => '&apos;',
  "\r" => '&#xd;'
}
EncodeCharRegexp = 
Regexp.new("[#{EncodeMap.keys.join}]")

Constants included from SOAP

AttrActor, AttrActorName, AttrArrayType, AttrArrayTypeName, AttrEncodingStyle, AttrEncodingStyleName, AttrMustUnderstand, AttrMustUnderstandName, AttrOffset, AttrOffsetName, AttrPosition, AttrPositionName, AttrRoot, AttrRootName, Base64Literal, Charset, EleBody, EleBodyName, EleEnvelope, EleEnvelopeName, EleFault, EleFaultActor, EleFaultActorName, EleFaultCode, EleFaultCodeName, EleFaultDetail, EleFaultDetailName, EleFaultName, EleFaultString, EleFaultStringName, EleHeader, EleHeaderName, EncodingNamespace, EnvelopeNamespace, LiteralNamespace, MediaType, NS, NextActor, PropertyName, RPCRouter, RPCServerException, RPCUtils, SOAPNamespaceTag, SOAPProxy, TypeMap, VERSION, ValueArray, ValueArrayName, XSDNamespaceTag, XSINamespaceTag

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(opt = {}) ⇒ SOAPGenerator

Returns a new instance of SOAPGenerator.



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/soap/generator.rb', line 33

def initialize(opt = {})
  @reftarget = nil
  @handlers = {}
  @charset = opt[:charset] || XSD::Charset.xml_encoding_label
  @default_encodingstyle = opt[:default_encodingstyle] || EncodingNamespace
  @generate_explicit_type =
    opt.key?(:generate_explicit_type) ? opt[:generate_explicit_type] : true
  # elementformdefault is for default namespace usage controll
  # TODO: should be renamed
  @elementformdefault = opt[:elementformdefault]
  @attributeformdefault = opt[:attributeformdefault]
  @use_numeric_character_reference = opt[:use_numeric_character_reference]
  @indentstr = opt[:no_indent] ? '' : '  '
  @buf = @indent = @curr = nil
end

Instance Attribute Details

#charset ⇒ Object

Returns the value of attribute charset.



28
29
30
 
# File 'lib/soap/generator.rb', line 28

def charset
  @charset
end

#default_encodingstyle ⇒ Object

Returns the value of attribute default_encodingstyle.



29
30
31
 
# File 'lib/soap/generator.rb', line 29

def default_encodingstyle
  @default_encodingstyle
end

#generate_explicit_type ⇒ Object

Returns the value of attribute generate_explicit_type.



30
31
32
 
# File 'lib/soap/generator.rb', line 30

def generate_explicit_type
  @generate_explicit_type
end

#use_numeric_character_reference ⇒ Object

Returns the value of attribute use_numeric_character_reference.



31
32
33
 
# File 'lib/soap/generator.rb', line 31

def use_numeric_character_reference
  @use_numeric_character_reference
end

Class Method Details

.assign_ns(attrs, ns, namespace, tag = nil) ⇒ Object 



221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/soap/generator.rb', line 221

def self.assign_ns(attrs, ns, namespace, tag = nil)
  if namespace.nil?
    raise FormatEncodeError.new("empty namespace")
  end
  unless ns.assigned?(namespace)
    tag = ns.assign(namespace, tag)
    if tag == ''
      attr = 'xmlns'
    else
      attr = "xmlns:#{tag}"
    end
    attrs[attr] = namespace
  end
end

Instance Method Details

#add_reftarget(name, node) ⇒ Object 



99
100
101
102
103
104
 
# File 'lib/soap/generator.rb', line 99

def add_reftarget(name, node)
  unless @reftarget
    raise FormatEncodeError.new("Reftarget is not defined.")
  end
  @reftarget.add(name, node)
end

#element_local?(element) ⇒ Boolean

Returns:

  • (Boolean) 


217
218
219
 
# File 'lib/soap/generator.rb', line 217

def element_local?(element)
  element.elename.namespace.nil?
end

#encode_child(ns, child, parent) ⇒ Object 



106
107
108
109
110
 
# File 'lib/soap/generator.rb', line 106

def encode_child(ns, child, parent)
  indent_backup, @indent = @indent, @indent + @indentstr
  encode_data(ns.clone_ns, child, parent)
  @indent = indent_backup
end

#encode_data(ns, obj, parent) ⇒ Object 



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/soap/generator.rb', line 70

def encode_data(ns, obj, parent)
  if obj.is_a?(SOAPEnvelopeElement)
    encode_element(ns, obj, parent)
    return
  end
  if @reftarget && !obj.precedents.empty?
    add_reftarget(obj.elename.name, obj)
    ref = SOAPReference.new(obj)
    ref.elename = ref.elename.dup_name(obj.elename.name)
    obj.precedents.clear	# Avoid cyclic delay.
    obj.encodingstyle = parent.encodingstyle
    # SOAPReference is encoded here.
    obj = ref
  end
  encodingstyle = obj.encodingstyle
  # Children's encodingstyle is derived from its parent.
  encodingstyle ||= parent.encodingstyle if parent
  obj.encodingstyle = encodingstyle
  handler = find_handler(encodingstyle || @default_encodingstyle)
  unless handler
    raise FormatEncodeError.new("Unknown encodingStyle: #{ encodingstyle }.")
  end
  if !obj.elename.name
    raise FormatEncodeError.new("Element name not defined: #{ obj }.")
  end
  handler.encode_data(self, ns, obj, parent)
  handler.encode_data_end(self, ns, obj, parent)
end

#encode_element(ns, obj, parent) ⇒ Object 



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/soap/generator.rb', line 112

def encode_element(ns, obj, parent)
  attrs = {}
  if obj.is_a?(SOAPBody)
    @reftarget = obj
    obj.encode(self, ns, attrs) do |child|
	indent_backup, @indent = @indent, @indent + @indentstr
      encode_data(ns.clone_ns, child, obj)
	@indent = indent_backup
    end
    @reftarget = nil
  else
    if obj.is_a?(SOAPEnvelope)
      # xsi:nil="true" can appear even if dumping without explicit type.
      SOAPGenerator.assign_ns(attrs, ns,
 XSD::InstanceNamespace, XSINamespaceTag)
      if @generate_explicit_type
        SOAPGenerator.assign_ns(attrs, ns, XSD::Namespace, XSDNamespaceTag)
      end
    end
    obj.encode(self, ns, attrs) do |child|
	indent_backup, @indent = @indent, @indent + @indentstr
      encode_data(ns.clone_ns, child, obj)
	@indent = indent_backup
    end
  end
end

#encode_name(ns, data, attrs) ⇒ Object 



139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/soap/generator.rb', line 139

def encode_name(ns, data, attrs)
  if element_local?(data)
    data.elename.name
  else
    if @elementformdefault
      SOAPGenerator.assign_ns(attrs, ns, data.elename.namespace, '')
    else
      SOAPGenerator.assign_ns(attrs, ns, data.elename.namespace)
    end
    ns.name(data.elename)
  end
end

#encode_name_end(ns, data) ⇒ Object 



152
153
154
155
156
157
158
 
# File 'lib/soap/generator.rb', line 152

def encode_name_end(ns, data)
  if element_local?(data)
    data.elename.name
  else
    ns.name(data.elename)
  end
end

#encode_rawstring(str) ⇒ Object 



189
190
191
 
# File 'lib/soap/generator.rb', line 189

def encode_rawstring(str)
  @buf << str
end

#encode_string(str) ⇒ Object 



202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/soap/generator.rb', line 202

def encode_string(str)
  if @use_numeric_character_reference and !XSD::Charset.is_us_ascii(str)
    str.gsub!(EncodeCharRegexp) { |c| EncodeMap[c] }
    @buf << str.unpack("U*").collect { |c|
      if c == 0x9 or c == 0xa or c == 0xd or (c >= 0x20 and c <= 0x7f)
        c.chr
      else
        sprintf("&#x%x;", c)
      end
    }.join
  else
    @buf << str.gsub(EncodeCharRegexp) { |c| EncodeMap[c] }
  end
end

#encode_tag(elename, attrs = nil) ⇒ Object 



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/soap/generator.rb', line 160

def encode_tag(elename, attrs = nil)
  if attrs.nil? or attrs.empty?
    @buf << "\n#{ @indent }<#{ elename }>"
    return 
  end
  ary = []
  attrs.each do |key, value|
    ary << %Q[#{ key }="#{ value }"] unless value.nil?
  end
  case ary.size
  when 0
    @buf << "\n#{ @indent }<#{ elename }>"
  when 1
    @buf << %Q[\n#{ @indent }<#{ elename } #{ ary[0] }>]
  else
    @buf << "\n#{ @indent }<#{ elename } " <<
      ary.join("\n#{ @indent }#{ @indentstr * 2 }") <<
	'>'
  end
end

#encode_tag_end(elename, cr = nil) ⇒ Object 



181
182
183
184
185
186
187
 
# File 'lib/soap/generator.rb', line 181

def encode_tag_end(elename, cr = nil)
  if cr
    @buf << "\n#{ @indent }</#{ elename }>"
  else
    @buf << "</#{ elename }>"
  end
end

#generate(obj, io = nil) ⇒ Object 



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/soap/generator.rb', line 49

def generate(obj, io = nil)
  @buf = io || ''
  @indent = ''

  prologue
  @handlers.each do |uri, handler|
    handler.encode_prologue
  end

  ns = XSD::NS.new
  @buf << xmldecl
  encode_data(ns, obj, nil)

  @handlers.each do |uri, handler|
    handler.encode_epilogue
  end
  epilogue

  @buf
end