Module: CGI::QueryExtension

Relationships & Source Files
Defined in:	lib/cgi/core.rb

Overview

Mixin module that provides the following:

Access to the ::CGI environment variables as methods. See documentation to the CGI class for a list of these variables. The methods are exposed by removing the leading HTTP_ (if it exists) and downcasing the name. For example, auth_type will return the environment variable AUTH_TYPE, and accept will return the value for HTTP_ACCEPT.
Access to cookies, including the cookies attribute.
Access to parameters, including the params attribute, and overloading #[] to perform parameter value lookup by key.
The initialize_query method, for initializing the above mechanisms, handling multipart forms, and allowing the class to be used in “offline” mode.

Instance Attribute Summary

#cookies rw

Get the cookies as a hash of cookie-name=>Cookie pairs.
#files readonly

Get the uploaded files as a hash of name=>values pairs.
#multipart? ⇒ Boolean readonly

Returns whether the form contained multipart/form-data.
#params rw

Get the parameters as a hash of name=>values pairs, where values is an Array.
#params=(hash) rw

Set all the parameters.
#unescape_filename? ⇒ Boolean readonly Internal use only

Instance Method Summary

#[](key)

Get the value for the parameter with a given key.
#has_key?(*args) ⇒ Boolean (also: #key?, #include?)

Returns true if a given query string parameter exists.
#include?(*args)

Alias for #has_key?.
#key?(*args)

Alias for #has_key?.
#keys(*args)

Return all query parameter names as an array of String.
#raw_cookie

Get the raw cookies as a string.
#raw_cookie2

Get the raw RFC2965 cookies as a string.
#initialize_query private

A wrapper class to use a StringIO object as the body and switch to a TempFile when the passed threshold is passed.
#read_from_cmdline private

offline mode.
#read_multipart(boundary, content_length) private

Parses multipart form elements according to www.w3.org/TR/html401/interact/forms.html#h-17.13.4.2.
#create_body(is_large) Internal use only

Instance Attribute Details

#cookies (rw)

Get the cookies as a hash of cookie-name=>Cookie pairs.

[ GitHub ]

# File 'lib/cgi/core.rb', line 453


attr_accessor :cookies

#files (readonly)

Get the uploaded files as a hash of name=>values pairs

[ GitHub ]

# File 'lib/cgi/core.rb', line 460


attr_reader :files

#multipart? ⇒ `Boolean` (readonly)

Returns whether the form contained multipart/form-data

[ GitHub ]

# File 'lib/cgi/core.rb', line 694


def multipart?
  @multipart
end

#params (rw)

Get the parameters as a hash of name=>values pairs, where values is an Array.

[ GitHub ]

# File 'lib/cgi/core.rb', line 457


attr_reader :params

#params=(hash) (rw)

Set all the parameters.

[ GitHub ]

# File 'lib/cgi/core.rb', line 463


def params=(hash)
  @params.clear
  @params.update(hash)
end

#unescape_filename? ⇒ `Boolean` (readonly)

This method is for internal use only.

[ GitHub ]

# File 'lib/cgi/core.rb', line 608


def unescape_filename?  #:nodoc:
  user_agent = $CGI_ENV['HTTP_USER_AGENT']
  return /Mac/i.match(user_agent) && /Mozilla/i.match(user_agent) && !/MSIE/i.match(user_agent)
end

Instance Method Details

#[](key)

Get the value for the parameter with a given key.

If the parameter has multiple values, only the first will be retrieved; use #params to get the array of values.

[ GitHub ]

# File 'lib/cgi/core.rb', line 702


def [](key)
  params = @params[key]
  return '' unless params
  value = params[0]
  if @multipart
    if value
      return value
    elsif defined? StringIO
      StringIO.new("".b)
    else
      Tempfile.new("CGI",encoding: Encoding::ASCII_8BIT)
    end
  else
    str = if value then value.dup else "" end
    str
  end
end

#create_body(is_large)

This method is for internal use only.

[ GitHub ]

# File 'lib/cgi/core.rb', line 592


def create_body(is_large)  #:nodoc:
  if is_large
    require 'tempfile'
    body = Tempfile.new('CGI', encoding: Encoding::ASCII_8BIT)
  else
    begin
      require 'stringio'
      body = StringIO.new("".b)
    rescue LoadError
      require 'tempfile'
      body = Tempfile.new('CGI', encoding: Encoding::ASCII_8BIT)
    end
  end
  body.binmode if defined? body.binmode
  return body
end

#has_key?(*args) ⇒ `Boolean` Also known as: #key?, #include?

Returns true if a given query string parameter exists.

[ GitHub ]

# File 'lib/cgi/core.rb', line 726


def has_key?(*args)
  @params.has_key?(*args)
end

#include?(*args)

Alias for #has_key?.

[ GitHub ]

# File 'lib/cgi/core.rb', line 730


alias include? has_key?

#initialize_query (private)

A wrapper class to use a StringIO object as the body and switch to a TempFile when the passed threshold is passed. Initialize the data from the query.

Handles multipart forms (in particular, forms that involve file uploads). Reads query parameters in the @params field, and cookies into @cookies.

[ GitHub ]

# File 'lib/cgi/core.rb', line 649


def initialize_query()
  if ("POST" == env_table['REQUEST_METHOD']) and
    %r|\Amultipart/form-data.*boundary=\"?([^\";,]+)\"?|.match(env_table['CONTENT_TYPE'])
    current_max_multipart_length = @max_multipart_length.respond_to?(:call) ? @max_multipart_length.call : @max_multipart_length
    raise StandardError.new("too large multipart data.") if env_table['CONTENT_LENGTH'].to_i > current_max_multipart_length
    boundary = $1.dup
    @multipart = true
    @params = read_multipart(boundary, Integer(env_table['CONTENT_LENGTH']))
  else
    @multipart = false
    @params = CGI::parse(
                case env_table['REQUEST_METHOD']
                when "GET", "HEAD"
                  if defined?(MOD_RUBY)
                    Apache::request.args or ""
                  else
                    env_table['QUERY_STRING'] or ""
                  end
                when "POST"
                  stdinput.binmode if defined? stdinput.binmode
                  stdinput.read(Integer(env_table['CONTENT_LENGTH'])) or ''
                else
                  read_from_cmdline
                end.dup.force_encoding(@accept_charset)
              )
    unless Encoding.find(@accept_charset) == Encoding::ASCII_8BIT
      @params.each do |key,values|
        values.each do |value|
          unless value.valid_encoding?
            if @accept_charset_error_block
              @accept_charset_error_block.call(key,value)
            else
              raise InvalidEncoding,"Accept-Charset encoding error"
            end
          end
        end
      end
    end
  end

  @cookies = CGI::Cookie::parse((env_table['HTTP_COOKIE'] or env_table['COOKIE']))
end

#key?(*args)

Alias for #has_key?.

[ GitHub ]

# File 'lib/cgi/core.rb', line 729


alias key? has_key?

#keys(*args)

Return all query parameter names as an array of String.

[ GitHub ]

# File 'lib/cgi/core.rb', line 721


def keys(*args)
  @params.keys(*args)
end

#raw_cookie

Get the raw cookies as a string.

[ GitHub ]

# File 'lib/cgi/core.rb', line 443


def raw_cookie
  env_table["HTTP_COOKIE"]
end

#raw_cookie2

Get the raw RFC2965 cookies as a string.

[ GitHub ]

# File 'lib/cgi/core.rb', line 448


def raw_cookie2
  env_table["HTTP_COOKIE2"]
end

#read_from_cmdline (private)

offline mode. read name=value pairs on standard input.

[ GitHub ]

# File 'lib/cgi/core.rb', line 614


def read_from_cmdline
  require "shellwords"

  string = unless ARGV.empty?
    ARGV.join(' ')
  else
    if STDIN.tty?
      STDERR.print(
        %|(offline mode: enter name=value pairs on standard input)\n|
      )
    end
    array = readlines rescue nil
    if not array.nil?
        array.join(' ').gsub(/\n/n, '')
    else
        ""
    end
  end.gsub(/\\=/n, '%3D').gsub(/\\&/n, '%26')

  words = Shellwords.shellwords(string)

  if words.find{|x| /=/n.match(x) }
    words.join('&')
  else
    words.join('+')
  end
end

#read_multipart(boundary, content_length) (private)

Parses multipart form elements according to www.w3.org/TR/html401/interact/forms.html#h-17.13.4.2

Returns a hash of multipart form parameters with bodies of type StringIO or Tempfile depending on whether the multipart form element exceeds 10 KB

params[name => body]

[ GitHub ]

# File 'lib/cgi/core.rb', line 477


def read_multipart(boundary, content_length)
  ## read first boundary
  stdin = stdinput
  first_line = "--#{boundary}#{EOL}"
  content_length -= first_line.bytesize
  status = stdin.read(first_line.bytesize)
  raise EOFError.new("no content body")  unless status
  raise EOFError.new("bad content body") unless first_line == status
  ## parse and set params
  params = {}
  @files = {}
  boundary_rexp = /--#{Regexp.quote(boundary)}(#{EOL}|--)/
  boundary_size = "#{EOL}--#{boundary}#{EOL}".bytesize
  buf = ''.dup
  bufsize = 10 * 1024
  max_count = MAX_MULTIPART_COUNT
  n = 0
  tempfiles = []
  while true
    (n += 1) < max_count or raise StandardError.new("too many parameters.")
    ## create body (StringIO or Tempfile)
    body = create_body(bufsize < content_length)
    tempfiles << body if defined?(Tempfile) && body.kind_of?(Tempfile)
    class << body
      if method_defined?(:path)
        alias local_path path
      else
        def local_path
          nil
        end
      end
      attr_reader :original_filename, :content_type
    end
    ## find head and boundary
    head = nil
    separator = EOL * 2
    until head && matched = boundary_rexp.match(buf)
      if !head && pos = buf.index(separator)
        len  = pos + EOL.bytesize
        head = buf[0, len]
        buf  = buf[(pos+separator.bytesize)..-1]
      else
        if head && buf.size > boundary_size
          len = buf.size - boundary_size
          body.print(buf[0, len])
          buf[0, len] = ''
        end
        c = stdin.read(bufsize < content_length ? bufsize : content_length)
        raise EOFError.new("bad content body") if c.nil? || c.empty?
        buf << c
        content_length -= c.bytesize
      end
    end
    ## read to end of boundary
    m = matched
    len = m.begin(0)
    s = buf[0, len]
    if s =~ /(\r?\n)\z/
      s = buf[0, len - $1.bytesize]
    end
    body.print(s)
    buf = buf[m.end(0)..-1]
    boundary_end = m[1]
    content_length = -1 if boundary_end == '--'
    ## reset file cursor position
    body.rewind
    ## original filename
    /Content-Disposition:.* filename=(?:"(.*?)"|([^;\r\n]*))/i.match(head)
    filename = $1 || $2 || ''.dup
    filename = CGI.unescape(filename) if unescape_filename?()
    body.instance_variable_set(:@original_filename, filename.taint)
    ## content type
    /Content-Type: (.*)/i.match(head)
    (content_type = $1 || ''.dup).chomp!
    body.instance_variable_set(:@content_type, content_type.taint)
    ## query parameter name
    /Content-Disposition:.* name=(?:"(.*?)"|([^;\r\n]*))/i.match(head)
    name = $1 || $2 || ''
    if body.original_filename.empty?
      value=body.read.dup.force_encoding(@accept_charset)
      body.close! if defined?(Tempfile) && body.kind_of?(Tempfile)
      (params[name] ||= []) << value
      unless value.valid_encoding?
        if @accept_charset_error_block
          @accept_charset_error_block.call(name,value)
        else
          raise InvalidEncoding,"Accept-Charset encoding error"
        end
      end
      class << params[name].last;self;end.class_eval do
        define_method(:read){self}
        define_method(:original_filename){""}
        define_method(:content_type){""}
      end
    else
      (params[name] ||= []) << body
      @files[name]=body
    end
    ## break loop
    break if content_length == -1
  end
  raise EOFError, "bad boundary end of body part" unless boundary_end =~ /--/
  params.default = []
  params
rescue Exception
  if tempfiles
    tempfiles.each {|t|
      if t.path
        t.close!
      end
    }
  end
  raise
end

Module: CGI::QueryExtension

Overview

Instance Attribute Summary

Instance Method Summary

Instance Attribute Details

#cookies (rw)

#files (readonly)

#multipart? ⇒ Boolean (readonly)

#params (rw)

#params=(hash) (rw)

#unescape_filename? ⇒ Boolean (readonly)

Instance Method Details

#[](key)

#create_body(is_large)

#has_key?(*args) ⇒ Boolean Also known as: #key?, #include?

#include?(*args)

#initialize_query (private)

#key?(*args)

#keys(*args)

#raw_cookie

#raw_cookie2

#read_from_cmdline (private)

#read_multipart(boundary, content_length) (private)

#multipart? ⇒ `Boolean` (readonly)

#unescape_filename? ⇒ `Boolean` (readonly)

#has_key?(*args) ⇒ `Boolean` Also known as: #key?, #include?