Class: WEBrick::HTTPUtils::FormData

Inherits:
String
  • Object
show all
Defined in:
lib/webrick/httputils.rb

Overview

Stores multipart form data. FormData objects are created when WEBrick::HTTPUtils.parse_form_data is called.

Constant Summary collapse

EmptyRawHeader =

:nodoc:

[].freeze
EmptyHeader =

:nodoc:

{}.freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*args) ⇒ FormData

Creates a new FormData object.

args is an Array of form data entries. One FormData will be created for each entry.

This is called by WEBrick::HTTPUtils.parse_form_data for you


264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
# File 'lib/webrick/httputils.rb', line 264

def initialize(*args)
  @name = @filename = @next_data = nil
  if args.empty?
    @raw_header = []
    @header = nil
    super("")
  else
    @raw_header = EmptyRawHeader
    @header = EmptyHeader
    super(args.shift)
    unless args.empty?
      @next_data = self.class.new(*args)
    end
  end
end

Instance Attribute Details

#filenameObject

The filename of the form data part


251
252
253
# File 'lib/webrick/httputils.rb', line 251

def filename
  @filename
end

#nameObject

The name of the form data part


246
247
248
# File 'lib/webrick/httputils.rb', line 246

def name
  @name
end

#next_data=(value) ⇒ Object

:nodoc:


253
254
255
# File 'lib/webrick/httputils.rb', line 253

def next_data=(value)
  @next_data = value
end

Instance Method Details

#<<(str) ⇒ Object

Adds str to this FormData which may be the body, a header or a header entry.

This is called by WEBrick::HTTPUtils.parse_form_data for you


297
298
299
300
301
302
303
304
305
306
307
308
309
310
# File 'lib/webrick/httputils.rb', line 297

def <<(str)
  if @header
    super
  elsif str == CRLF
    @header = HTTPUtils::parse_header(@raw_header.join)
    if cd = self['content-disposition']
      if /\s+name="(.*?)"/ =~ cd then @name = $1 end
      if /\s+filename="(.*?)"/ =~ cd then @filename = $1 end
    end
  else
    @raw_header << str
  end
  self
end

#[](*key) ⇒ Object

Retrieves the header at the first entry in key


283
284
285
286
287
288
289
# File 'lib/webrick/httputils.rb', line 283

def [](*key)
  begin
    @header[key[0].downcase].join(", ")
  rescue StandardError, NameError
    super
  end
end

#append_data(data) ⇒ Object

Adds data at the end of the chain of entries

This is called by WEBrick::HTTPUtils.parse_form_data for you.


317
318
319
320
321
322
323
324
325
326
327
# File 'lib/webrick/httputils.rb', line 317

def append_data(data)
  tmp = self
  while tmp
    unless tmp.next_data
      tmp.next_data = data
      break
    end
    tmp = tmp.next_data
  end
  self
end

#each_dataObject

Yields each entry in this FormData


332
333
334
335
336
337
338
339
# File 'lib/webrick/httputils.rb', line 332

def each_data
  tmp = self
  while tmp
    next_data = tmp.next_data
    yield(tmp)
    tmp = next_data
  end
end

#listObject Also known as: to_ary

Returns all the FormData as an Array


344
345
346
347
348
349
350
# File 'lib/webrick/httputils.rb', line 344

def list
  ret = []
  each_data{|data|
    ret << data.to_s
  }
  ret
end

#to_sObject

This FormData's body


360
361
362
# File 'lib/webrick/httputils.rb', line 360

def to_s
  String.new(self)
end