Parent

Class/Module Index [+]

Quicksearch

MIME::Types

MIME::Types

MIME types are used in MIME-compliant communications, as in e-mail or HTTP traffic, to indicate the type of content which is transmitted. MIME::Types provides the ability for detailed information about MIME entities (provided as a set of MIME::Type objects) to be determined and used programmatically. There are many types defined by RFCs and vendors, so the list is long but not complete; don't hesitate to ask to add additional information. This library follows the IANA collection of MIME types (see below for reference).

Description

MIME types are used in MIME entities, as in email or HTTP traffic. It is useful at times to have information available about MIME types (or, inversely, about files). A MIME::Type stores the known information about one MIME type.

Usage

require 'mime/types'

plaintext = MIME::Types['text/plain']
print plaintext.media_type           # => 'text'
print plaintext.sub_type             # => 'plain'

puts plaintext.extensions.join(" ")  # => 'asc txt c cc h hh cpp'

puts plaintext.encoding              # => 8bit
puts plaintext.binary?               # => false
puts plaintext.ascii?                # => true
puts plaintext.obsolete?             # => false
puts plaintext.registered?           # => true
puts plaintext == 'text/plain'       # => true
puts MIME::Type.simplified('x-appl/x-zip') # => 'appl/zip'

This module is built to conform to the MIME types of RFCs 2045 and 2231. It follows the official IANA registry at www.iana.org/assignments/media-types/ and ftp.iana.org/assignments/media-types with some unofficial types added from the the collection at www.ltsw.se/knbase/internet/mime.htp

This is originally based on Perl MIME::Types by Mark Overmeer.

Author

Copyright

Copyright 2002–2013 by Austin Ziegler <austin@rubyforge.org>

Version

1.20.1

Licence

See Licence.rdoc

See Also

www.iana.org/assignments/media-types/ www.ltsw.se/knbase/internet/mime.htp

Constants

STARTUP
TEXT_FORMAT_RE

The regular expression used to match a file-based MIME type definition.

VERSION

The released version of Ruby MIME::Types

Attributes

data_version[R]

The data version.

Public Class Methods

[](type_id, flags = {}) click to toggle source

Returns a list of MIME::Type objects, which may be empty. The optional flag parameters are :complete (finds only complete MIME::Type objects) and :platform (finds only MIME::Types for the current platform). It is possible for multiple matches to be returned for either type (in the example below, 'text/plain' returns two values -- one for the general case, and one for VMS systems.

puts "\nMIME::Types['text/plain']"
MIME::Types['text/plain'].each { |t| puts t.to_a.join(", ") }

puts "\nMIME::Types[/^image/, :complete => true]"
MIME::Types[/^image/, :complete => true].each do |t|
  puts t.to_a.join(", ")
end
# File lib/mime/types.rb, line 818
def [](type_id, flags = {})
  @__types__[type_id, flags]
end
add(*types) click to toggle source

Add one or more MIME::Type objects to the set of known types. Each type should be experimental (e.g., 'application/x-ruby'). If the type is already known, a warning will be displayed.

<strong>Please inform the maintainer of this module when registered types are missing.</strong>

# File lib/mime/types.rb, line 847
def add(*types)
  @__types__.add(*types)
end
new(data_version = nil) click to toggle source
# File lib/mime/types.rb, line 581
def initialize(data_version = nil)
  @type_variants    = Hash.new { |h, k| h[k] = [] }
  @extension_index  = Hash.new { |h, k| h[k] = [] }
  @data_version = data_version
end
of(filename, platform = false) click to toggle source

A synonym for MIME::Types.type_for

# File lib/mime/types.rb, line 837
def of(filename, platform = false)
  @__types__.type_for(filename, platform)
end
type_for(filename, platform = false) click to toggle source

Return the list of MIME::Types which belongs to the file based on its filename extension. If platform is true, then only file types that are specific to the current platform will be returned.

This will always return an array.

puts "MIME::Types.type_for('citydesk.xml')
  => [application/xml, text/xml]
puts "MIME::Types.type_for('citydesk.gif')
  => [image/gif]
# File lib/mime/types.rb, line 832
def type_for(filename, platform = false)
  @__types__.type_for(filename, platform)
end

Public Instance Methods

[](type_id, flags = {}) click to toggle source

Returns a list of MIME::Type objects, which may be empty. The optional flag parameters are :complete (finds only complete MIME::Type objects) and :platform (finds only MIME::Types for the current platform). It is possible for multiple matches to be returned for either type (in the example below, 'text/plain' returns two values -- one for the general case, and one for VMS systems.

puts "\nMIME::Types['text/plain']"
MIME::Types['text/plain'].each { |t| puts t.to_a.join(", ") }

puts "\nMIME::Types[/^image/, :complete => true]"
MIME::Types[/^image/, :complete => true].each do |t|
  puts t.to_a.join(", ")
end

If multiple type definitions are returned, returns them sorted as follows:

1. Complete definitions sort before incomplete ones;
2. IANA-registered definitions sort before LTSW-recorded
   definitions.
3. Generic definitions sort before platform-specific ones;
4. Current definitions sort before obsolete ones;
5. Obsolete definitions with use-instead clauses sort before those
   without;
6. Obsolete definitions use-instead clauses are compared.
7. Sort on name.
# File lib/mime/types.rb, line 627
def [](type_id, flags = {})
  if type_id.kind_of?(Regexp)
    matches = []
    @type_variants.each_key do |k|
      matches << @type_variants[k] if k =~ type_id
    end
    matches.flatten!
  elsif type_id.kind_of?(MIME::Type)
    matches = [type_id]
  else
    matches = @type_variants[MIME::Type.simplified(type_id)]
  end

  matches.delete_if { |e| not e.complete? } if flags[:complete]
  matches.delete_if { |e| not e.platform? } if flags[:platform]

  matches.sort { |a, b| a.priority_compare(b) }
end
add(*types) click to toggle source

Add one or more MIME::Type objects to the set of known types. Each type should be experimental (e.g., 'application/x-ruby'). If the type is already known, a warning will be displayed.

<strong>Please inform the maintainer of this module when registered types are missing.</strong>

# File lib/mime/types.rb, line 674
def add(*types)
  types.each do |mime_type|
    if mime_type.kind_of? MIME::Types
      add(*mime_type.defined_types)
    else
      if @type_variants.include?(mime_type.simplified)
        if @type_variants[mime_type.simplified].include?(mime_type)
          warn "Type #{mime_type} already registered as a variant of #{mime_type.simplified}." unless defined? MIME::Types::STARTUP
        end
      end
      add_type_variant(mime_type)
      index_extensions(mime_type)
    end
  end
end
of(filename, platform = false) click to toggle source

A synonym for MIME::Types.type_for

# File lib/mime/types.rb, line 664
def of(filename, platform = false)
  type_for(filename, platform)
end
type_for(filename, platform = false) click to toggle source

Return the list of MIME::Types which belongs to the file based on its filename extension. If platform is true, then only file types that are specific to the current platform will be returned.

This will always return an array.

puts "MIME::Types.type_for('citydesk.xml')
  => [application/xml, text/xml]
puts "MIME::Types.type_for('citydesk.gif')
  => [image/gif]
# File lib/mime/types.rb, line 656
def type_for(filename, platform = false)
  ext = filename.chomp.downcase.gsub(/.*\./, '')
  list = @extension_index[ext]
  list.delete_if { |e| not e.platform? } if platform
  list
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.