-
Notifications
You must be signed in to change notification settings - Fork 47
/
document.rb
451 lines (424 loc) · 14.1 KB
/
document.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
# frozen_string_literal: false
require_relative "security"
require_relative "element"
require_relative "xmldecl"
require_relative "source"
require_relative "comment"
require_relative "doctype"
require_relative "instruction"
require_relative "rexml"
require_relative "parseexception"
require_relative "output"
require_relative "parsers/baseparser"
require_relative "parsers/streamparser"
require_relative "parsers/treeparser"
module REXML
# Represents an XML document.
#
# A document may have:
#
# - A single child that may be accessed via method #root.
# - An XML declaration.
# - A document type.
# - Processing instructions.
#
# == In a Hurry?
#
# If you're somewhat familiar with XML
# and have a particular task in mind,
# you may want to see the
# {tasks pages}[../doc/rexml/tasks/tocs/master_toc_rdoc.html],
# and in particular, the
# {tasks page for documents}[../doc/rexml/tasks/tocs/document_toc_rdoc.html].
#
class Document < Element
# A convenient default XML declaration. Use:
#
# mydoc << XMLDecl.default
#
DECLARATION = XMLDecl.default
# :call-seq:
# new(string = nil, context = {}) -> new_document
# new(io_stream = nil, context = {}) -> new_document
# new(document = nil, context = {}) -> new_document
#
# Returns a new \REXML::Document object.
#
# When no arguments are given,
# returns an empty document:
#
# d = REXML::Document.new
# d.to_s # => ""
#
# When argument +string+ is given, it must be a string
# containing a valid XML document:
#
# xml_string = '<root><foo>Foo</foo><bar>Bar</bar></root>'
# d = REXML::Document.new(xml_string)
# d.to_s # => "<root><foo>Foo</foo><bar>Bar</bar></root>"
#
# When argument +io_stream+ is given, it must be an \IO object
# that is opened for reading, and when read must return a valid XML document:
#
# File.write('t.xml', xml_string)
# d = File.open('t.xml', 'r') do |io|
# REXML::Document.new(io)
# end
# d.to_s # => "<root><foo>Foo</foo><bar>Bar</bar></root>"
#
# When argument +document+ is given, it must be an existing
# document object, whose context and attributes (but not chidren)
# are cloned into the new document:
#
# d = REXML::Document.new(xml_string)
# d.children # => [<root> ... </>]
# d.context = {raw: :all, compress_whitespace: :all}
# d.add_attributes({'bar' => 0, 'baz' => 1})
# d1 = REXML::Document.new(d)
# d1.children # => []
# d1.context # => {:raw=>:all, :compress_whitespace=>:all}
# d1.attributes # => {"bar"=>bar='0', "baz"=>baz='1'}
#
# When argument +context+ is given, it must be a hash
# containing context entries for the document;
# see {Element Context}[../doc/rexml/context_rdoc.html]:
#
# context = {raw: :all, compress_whitespace: :all}
# d = REXML::Document.new(xml_string, context)
# d.context # => {:raw=>:all, :compress_whitespace=>:all}
#
def initialize( source = nil, context = {} )
@entity_expansion_count = 0
super()
@context = context
return if source.nil?
if source.kind_of? Document
@context = source.context
super source
else
build( source )
end
end
# :call-seq:
# node_type -> :document
#
# Returns the symbol +:document+.
#
def node_type
:document
end
# :call-seq:
# clone -> new_document
#
# Returns the new document resulting from executing
# <tt>Document.new(self)</tt>. See Document.new.
#
def clone
Document.new self
end
# :call-seq:
# expanded_name -> empty_string
#
# Returns an empty string.
#
def expanded_name
''
#d = doc_type
#d ? d.name : "UNDEFINED"
end
alias :name :expanded_name
# :call-seq:
# add(xml_decl) -> self
# add(doc_type) -> self
# add(object) -> self
#
# Adds an object to the document; returns +self+.
#
# When argument +xml_decl+ is given,
# it must be an REXML::XMLDecl object,
# which becomes the XML declaration for the document,
# replacing the previous XML declaration if any:
#
# d = REXML::Document.new
# d.xml_decl.to_s # => ""
# d.add(REXML::XMLDecl.new('2.0'))
# d.xml_decl.to_s # => "<?xml version='2.0'?>"
#
# When argument +doc_type+ is given,
# it must be an REXML::DocType object,
# which becomes the document type for the document,
# replacing the previous document type, if any:
#
# d = REXML::Document.new
# d.doctype.to_s # => ""
# d.add(REXML::DocType.new('foo'))
# d.doctype.to_s # => "<!DOCTYPE foo>"
#
# When argument +object+ (not an REXML::XMLDecl or REXML::DocType object)
# is given it is added as the last child:
#
# d = REXML::Document.new
# d.add(REXML::Element.new('foo'))
# d.to_s # => "<foo/>"
#
def add( child )
if child.kind_of? XMLDecl
if @children[0].kind_of? XMLDecl
@children[0] = child
else
@children.unshift child
end
child.parent = self
elsif child.kind_of? DocType
# Find first Element or DocType node and insert the decl right
# before it. If there is no such node, just insert the child at the
# end. If there is a child and it is an DocType, then replace it.
insert_before_index = @children.find_index { |x|
x.kind_of?(Element) || x.kind_of?(DocType)
}
if insert_before_index # Not null = not end of list
if @children[ insert_before_index ].kind_of? DocType
@children[ insert_before_index ] = child
else
@children[ insert_before_index-1, 0 ] = child
end
else # Insert at end of list
@children << child
end
child.parent = self
else
rv = super
raise "attempted adding second root element to document" if @elements.size > 1
rv
end
end
alias :<< :add
# :call-seq:
# add_element(name_or_element = nil, attributes = nil) -> new_element
#
# Adds an element to the document by calling REXML::Element.add_element:
#
# REXML::Element.add_element(name_or_element, attributes)
def add_element(arg=nil, arg2=nil)
rv = super
raise "attempted adding second root element to document" if @elements.size > 1
rv
end
# :call-seq:
# root -> root_element or nil
#
# Returns the root element of the document, if it exists, otherwise +nil+:
#
# d = REXML::Document.new('<root></root>')
# d.root # => <root/>
# d = REXML::Document.new('')
# d.root # => nil
#
def root
elements[1]
#self
#@children.find { |item| item.kind_of? Element }
end
# :call-seq:
# doctype -> doc_type or nil
#
# Returns the DocType object for the document, if it exists, otherwise +nil+:
#
# d = REXML::Document.new('<!DOCTYPE document SYSTEM "subjects.dtd">')
# d.doctype.class # => REXML::DocType
# d = REXML::Document.new('')
# d.doctype.class # => nil
#
def doctype
@children.find { |item| item.kind_of? DocType }
end
# :call-seq:
# xml_decl -> xml_decl
#
# Returns the XMLDecl object for the document, if it exists,
# otherwise the default XMLDecl object:
#
# d = REXML::Document.new('<?xml version="1.0" encoding="UTF-8"?>')
# d.xml_decl.class # => REXML::XMLDecl
# d.xml_decl.to_s # => "<?xml version='1.0' encoding='UTF-8'?>"
# d = REXML::Document.new('')
# d.xml_decl.class # => REXML::XMLDecl
# d.xml_decl.to_s # => ""
#
def xml_decl
rv = @children[0]
return rv if rv.kind_of? XMLDecl
@children.unshift(XMLDecl.default)[0]
end
# :call-seq:
# version -> version_string
#
# Returns the XMLDecl version of this document as a string,
# if it has been set, otherwise the default version:
#
# d = REXML::Document.new('<?xml version="2.0" encoding="UTF-8"?>')
# d.version # => "2.0"
# d = REXML::Document.new('')
# d.version # => "1.0"
#
def version
xml_decl().version
end
# :call-seq:
# encoding -> encoding_string
#
# Returns the XMLDecl encoding of the document,
# if it has been set, otherwise the default encoding:
#
# d = REXML::Document.new('<?xml version="1.0" encoding="UTF-16"?>')
# d.encoding # => "UTF-16"
# d = REXML::Document.new('')
# d.encoding # => "UTF-8"
#
def encoding
xml_decl().encoding
end
# :call-seq:
# stand_alone?
#
# Returns the XMLDecl standalone value of the document as a string,
# if it has been set, otherwise the default standalone value:
#
# d = REXML::Document.new('<?xml standalone="yes"?>')
# d.stand_alone? # => "yes"
# d = REXML::Document.new('')
# d.stand_alone? # => nil
#
def stand_alone?
xml_decl().stand_alone?
end
# :call-seq:
# doc.write(output=$stdout, indent=-1, transtive=false, ie_hack=false, encoding=nil)
# doc.write(options={:output => $stdout, :indent => -1, :transtive => false, :ie_hack => false, :encoding => nil})
#
# Write the XML tree out, optionally with indent. This writes out the
# entire XML document, including XML declarations, doctype declarations,
# and processing instructions (if any are given).
#
# A controversial point is whether Document should always write the XML
# declaration (<?xml version='1.0'?>) whether or not one is given by the
# user (or source document). REXML does not write one if one was not
# specified, because it adds unnecessary bandwidth to applications such
# as XML-RPC.
#
# Accept Nth argument style and options Hash style as argument.
# The recommended style is options Hash style for one or more
# arguments case.
#
# _Examples_
# Document.new("<a><b/></a>").write
#
# output = ""
# Document.new("<a><b/></a>").write(output)
#
# output = ""
# Document.new("<a><b/></a>").write(:output => output, :indent => 2)
#
# See also the classes in the rexml/formatters package for the proper way
# to change the default formatting of XML output.
#
# _Examples_
#
# output = ""
# tr = Transitive.new
# tr.write(Document.new("<a><b/></a>"), output)
#
# output::
# output an object which supports '<< string'; this is where the
# document will be written.
# indent::
# An integer. If -1, no indenting will be used; otherwise, the
# indentation will be twice this number of spaces, and children will be
# indented an additional amount. For a value of 3, every item will be
# indented 3 more levels, or 6 more spaces (2 * 3). Defaults to -1
# transitive::
# If transitive is true and indent is >= 0, then the output will be
# pretty-printed in such a way that the added whitespace does not affect
# the absolute *value* of the document -- that is, it leaves the value
# and number of Text nodes in the document unchanged.
# ie_hack::
# This hack inserts a space before the /> on empty tags to address
# a limitation of Internet Explorer. Defaults to false
# encoding::
# Encoding name as String. Change output encoding to specified encoding
# instead of encoding in XML declaration.
# Defaults to nil. It means encoding in XML declaration is used.
def write(*arguments)
if arguments.size == 1 and arguments[0].class == Hash
options = arguments[0]
output = options[:output]
indent = options[:indent]
transitive = options[:transitive]
ie_hack = options[:ie_hack]
encoding = options[:encoding]
else
output, indent, transitive, ie_hack, encoding, = *arguments
end
output ||= $stdout
indent ||= -1
transitive = false if transitive.nil?
ie_hack = false if ie_hack.nil?
encoding ||= xml_decl.encoding
if encoding != 'UTF-8' && !output.kind_of?(Output)
output = Output.new( output, encoding )
end
formatter = if indent > -1
if transitive
require_relative "formatters/transitive"
REXML::Formatters::Transitive.new( indent, ie_hack )
else
REXML::Formatters::Pretty.new( indent, ie_hack )
end
else
REXML::Formatters::Default.new( ie_hack )
end
formatter.write( self, output )
end
def Document::parse_stream( source, listener )
Parsers::StreamParser.new( source, listener ).parse
end
# Set the entity expansion limit. By default the limit is set to 10000.
#
# Deprecated. Use REXML::Security.entity_expansion_limit= instead.
def Document::entity_expansion_limit=( val )
Security.entity_expansion_limit = val
end
# Get the entity expansion limit. By default the limit is set to 10000.
#
# Deprecated. Use REXML::Security.entity_expansion_limit= instead.
def Document::entity_expansion_limit
return Security.entity_expansion_limit
end
# Set the entity expansion limit. By default the limit is set to 10240.
#
# Deprecated. Use REXML::Security.entity_expansion_text_limit= instead.
def Document::entity_expansion_text_limit=( val )
Security.entity_expansion_text_limit = val
end
# Get the entity expansion limit. By default the limit is set to 10240.
#
# Deprecated. Use REXML::Security.entity_expansion_text_limit instead.
def Document::entity_expansion_text_limit
return Security.entity_expansion_text_limit
end
attr_reader :entity_expansion_count
def record_entity_expansion
@entity_expansion_count += 1
if @entity_expansion_count > Security.entity_expansion_limit
raise "number of entity expansions exceeded, processing aborted."
end
end
def document
self
end
private
def build( source )
Parsers::TreeParser.new( source, self ).parse
end
end
end