xpflow 0.1b
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/bin/xpflow +96 -0
- data/lib/colorado.rb +198 -0
- data/lib/json/add/core.rb +243 -0
- data/lib/json/add/rails.rb +8 -0
- data/lib/json/common.rb +423 -0
- data/lib/json/editor.rb +1369 -0
- data/lib/json/ext.rb +28 -0
- data/lib/json/pure/generator.rb +442 -0
- data/lib/json/pure/parser.rb +320 -0
- data/lib/json/pure.rb +15 -0
- data/lib/json/version.rb +8 -0
- data/lib/json.rb +62 -0
- data/lib/mime/types.rb +881 -0
- data/lib/mime-types.rb +3 -0
- data/lib/restclient/abstract_response.rb +106 -0
- data/lib/restclient/exceptions.rb +193 -0
- data/lib/restclient/net_http_ext.rb +55 -0
- data/lib/restclient/payload.rb +235 -0
- data/lib/restclient/raw_response.rb +34 -0
- data/lib/restclient/request.rb +316 -0
- data/lib/restclient/resource.rb +169 -0
- data/lib/restclient/response.rb +24 -0
- data/lib/restclient.rb +174 -0
- data/lib/xpflow/bash.rb +341 -0
- data/lib/xpflow/bundle.rb +113 -0
- data/lib/xpflow/cmdline.rb +249 -0
- data/lib/xpflow/collection.rb +122 -0
- data/lib/xpflow/concurrency.rb +79 -0
- data/lib/xpflow/data.rb +393 -0
- data/lib/xpflow/dsl.rb +816 -0
- data/lib/xpflow/engine.rb +574 -0
- data/lib/xpflow/ensemble.rb +135 -0
- data/lib/xpflow/events.rb +56 -0
- data/lib/xpflow/experiment.rb +65 -0
- data/lib/xpflow/exts/facter.rb +30 -0
- data/lib/xpflow/exts/g5k.rb +931 -0
- data/lib/xpflow/exts/g5k_use.rb +50 -0
- data/lib/xpflow/exts/gui.rb +140 -0
- data/lib/xpflow/exts/model.rb +155 -0
- data/lib/xpflow/graph.rb +1603 -0
- data/lib/xpflow/graph_xpflow.rb +251 -0
- data/lib/xpflow/import.rb +196 -0
- data/lib/xpflow/library.rb +349 -0
- data/lib/xpflow/logging.rb +153 -0
- data/lib/xpflow/manager.rb +147 -0
- data/lib/xpflow/nodes.rb +1250 -0
- data/lib/xpflow/runs.rb +773 -0
- data/lib/xpflow/runtime.rb +125 -0
- data/lib/xpflow/scope.rb +168 -0
- data/lib/xpflow/ssh.rb +186 -0
- data/lib/xpflow/stat.rb +50 -0
- data/lib/xpflow/stdlib.rb +381 -0
- data/lib/xpflow/structs.rb +369 -0
- data/lib/xpflow/taktuk.rb +193 -0
- data/lib/xpflow/templates/ssh-config.basic +14 -0
- data/lib/xpflow/templates/ssh-config.inria +18 -0
- data/lib/xpflow/templates/ssh-config.proxy +13 -0
- data/lib/xpflow/templates/taktuk +6590 -0
- data/lib/xpflow/templates/utils/batch +4 -0
- data/lib/xpflow/templates/utils/bootstrap +12 -0
- data/lib/xpflow/templates/utils/hostname +3 -0
- data/lib/xpflow/templates/utils/ping +3 -0
- data/lib/xpflow/templates/utils/rsync +12 -0
- data/lib/xpflow/templates/utils/scp +17 -0
- data/lib/xpflow/templates/utils/scp_many +8 -0
- data/lib/xpflow/templates/utils/ssh +3 -0
- data/lib/xpflow/templates/utils/ssh-interactive +4 -0
- data/lib/xpflow/templates/utils/taktuk +19 -0
- data/lib/xpflow/threads.rb +187 -0
- data/lib/xpflow/utils.rb +569 -0
- data/lib/xpflow/visual.rb +230 -0
- data/lib/xpflow/with_g5k.rb +7 -0
- data/lib/xpflow.rb +349 -0
- metadata +135 -0
data/lib/mime/types.rb
ADDED
@@ -0,0 +1,881 @@
|
|
1
|
+
# -*- ruby encoding: utf-8 -*-
|
2
|
+
|
3
|
+
# The namespace for MIME applications, tools, and libraries.
|
4
|
+
module MIME
|
5
|
+
# Reflects a MIME Content-Type which is in invalid format (e.g., it isn't
|
6
|
+
# in the form of type/subtype).
|
7
|
+
class InvalidContentType < RuntimeError; end
|
8
|
+
|
9
|
+
# The definition of one MIME content-type.
|
10
|
+
#
|
11
|
+
# == Usage
|
12
|
+
# require 'mime/types'
|
13
|
+
#
|
14
|
+
# plaintext = MIME::Types['text/plain']
|
15
|
+
# print plaintext.media_type # => 'text'
|
16
|
+
# print plaintext.sub_type # => 'plain'
|
17
|
+
#
|
18
|
+
# puts plaintext.extensions.join(" ") # => 'asc txt c cc h hh cpp'
|
19
|
+
#
|
20
|
+
# puts plaintext.encoding # => 8bit
|
21
|
+
# puts plaintext.binary? # => false
|
22
|
+
# puts plaintext.ascii? # => true
|
23
|
+
# puts plaintext == 'text/plain' # => true
|
24
|
+
# puts MIME::Type.simplified('x-appl/x-zip') # => 'appl/zip'
|
25
|
+
#
|
26
|
+
class Type
|
27
|
+
# The released version of Ruby MIME::Types
|
28
|
+
VERSION = '1.23'
|
29
|
+
|
30
|
+
include Comparable
|
31
|
+
|
32
|
+
MEDIA_TYPE_RE = %r{([-\w.+]+)/([-\w.+]*)}o
|
33
|
+
UNREG_RE = %r{[Xx]-}o
|
34
|
+
ENCODING_RE = %r{(?:base64|7bit|8bit|quoted\-printable)}o
|
35
|
+
PLATFORM_RE = %r|#{RUBY_PLATFORM}|o
|
36
|
+
|
37
|
+
SIGNATURES = %w(application/pgp-keys application/pgp
|
38
|
+
application/pgp-signature application/pkcs10
|
39
|
+
application/pkcs7-mime application/pkcs7-signature
|
40
|
+
text/vcard)
|
41
|
+
|
42
|
+
IANA_URL = "http://www.iana.org/assignments/media-types/%s/%s"
|
43
|
+
RFC_URL = "http://rfc-editor.org/rfc/rfc%s.txt"
|
44
|
+
DRAFT_URL = "http://datatracker.ietf.org/public/idindex.cgi?command=id_details&filename=%s"
|
45
|
+
LTSW_URL = "http://www.ltsw.se/knbase/internet/%s.htp"
|
46
|
+
CONTACT_URL = "http://www.iana.org/assignments/contact-people.htm#%s"
|
47
|
+
|
48
|
+
# Returns +true+ if the simplified type matches the current
|
49
|
+
def like?(other)
|
50
|
+
if other.respond_to?(:simplified)
|
51
|
+
@simplified == other.simplified
|
52
|
+
else
|
53
|
+
@simplified == Type.simplified(other)
|
54
|
+
end
|
55
|
+
end
|
56
|
+
|
57
|
+
# Compares the MIME::Type against the exact content type or the
|
58
|
+
# simplified type (the simplified type will be used if comparing against
|
59
|
+
# something that can be treated as a String with #to_s). In comparisons,
|
60
|
+
# this is done against the lowercase version of the MIME::Type.
|
61
|
+
def <=>(other)
|
62
|
+
if other.respond_to?(:content_type)
|
63
|
+
@content_type.downcase <=> other.content_type.downcase
|
64
|
+
elsif other.respond_to?(:to_s)
|
65
|
+
@simplified <=> Type.simplified(other.to_s)
|
66
|
+
else
|
67
|
+
@content_type.downcase <=> other.downcase
|
68
|
+
end
|
69
|
+
end
|
70
|
+
|
71
|
+
# Compares the MIME::Type based on how reliable it is before doing a
|
72
|
+
# normal <=> comparison. Used by MIME::Types#[] to sort types. The
|
73
|
+
# comparisons involved are:
|
74
|
+
#
|
75
|
+
# 1. self.simplified <=> other.simplified (ensures that we
|
76
|
+
# don't try to compare different types)
|
77
|
+
# 2. IANA-registered definitions > other definitions.
|
78
|
+
# 3. Generic definitions > platform definitions.
|
79
|
+
# 3. Complete definitions > incomplete definitions.
|
80
|
+
# 4. Current definitions > obsolete definitions.
|
81
|
+
# 5. Obselete with use-instead references > obsolete without.
|
82
|
+
# 6. Obsolete use-instead definitions are compared.
|
83
|
+
def priority_compare(other)
|
84
|
+
pc = simplified <=> other.simplified
|
85
|
+
|
86
|
+
if pc.zero? and registered? != other.registered?
|
87
|
+
pc = registered? ? -1 : 1
|
88
|
+
end
|
89
|
+
|
90
|
+
if pc.zero? and platform? != other.platform?
|
91
|
+
pc = platform? ? 1 : -1
|
92
|
+
end
|
93
|
+
|
94
|
+
if pc.zero? and complete? != other.complete?
|
95
|
+
pc = complete? ? -1 : 1
|
96
|
+
end
|
97
|
+
|
98
|
+
if pc.zero? and obsolete? != other.obsolete?
|
99
|
+
pc = obsolete? ? 1 : -1
|
100
|
+
end
|
101
|
+
|
102
|
+
if pc.zero? and obsolete? and (use_instead != other.use_instead)
|
103
|
+
pc = if use_instead.nil?
|
104
|
+
-1
|
105
|
+
elsif other.use_instead.nil?
|
106
|
+
1
|
107
|
+
else
|
108
|
+
use_instead <=> other.use_instead
|
109
|
+
end
|
110
|
+
end
|
111
|
+
|
112
|
+
pc
|
113
|
+
end
|
114
|
+
|
115
|
+
# Returns +true+ if the other object is a MIME::Type and the content
|
116
|
+
# types match.
|
117
|
+
def eql?(other)
|
118
|
+
other.kind_of?(MIME::Type) and self == other
|
119
|
+
end
|
120
|
+
|
121
|
+
# Returns the whole MIME content-type string.
|
122
|
+
#
|
123
|
+
# text/plain => text/plain
|
124
|
+
# x-chemical/x-pdb => x-chemical/x-pdb
|
125
|
+
attr_reader :content_type
|
126
|
+
# Returns the media type of the simplified MIME type.
|
127
|
+
#
|
128
|
+
# text/plain => text
|
129
|
+
# x-chemical/x-pdb => chemical
|
130
|
+
attr_reader :media_type
|
131
|
+
# Returns the media type of the unmodified MIME type.
|
132
|
+
#
|
133
|
+
# text/plain => text
|
134
|
+
# x-chemical/x-pdb => x-chemical
|
135
|
+
attr_reader :raw_media_type
|
136
|
+
# Returns the sub-type of the simplified MIME type.
|
137
|
+
#
|
138
|
+
# text/plain => plain
|
139
|
+
# x-chemical/x-pdb => pdb
|
140
|
+
attr_reader :sub_type
|
141
|
+
# Returns the media type of the unmodified MIME type.
|
142
|
+
#
|
143
|
+
# text/plain => plain
|
144
|
+
# x-chemical/x-pdb => x-pdb
|
145
|
+
attr_reader :raw_sub_type
|
146
|
+
# The MIME types main- and sub-label can both start with <tt>x-</tt>,
|
147
|
+
# which indicates that it is a non-registered name. Of course, after
|
148
|
+
# registration this flag can disappear, adds to the confusing
|
149
|
+
# proliferation of MIME types. The simplified string has the <tt>x-</tt>
|
150
|
+
# removed and are translated to lowercase.
|
151
|
+
#
|
152
|
+
# text/plain => text/plain
|
153
|
+
# x-chemical/x-pdb => chemical/pdb
|
154
|
+
attr_reader :simplified
|
155
|
+
# The list of extensions which are known to be used for this MIME::Type.
|
156
|
+
# Non-array values will be coerced into an array with #to_a. Array
|
157
|
+
# values will be flattened and +nil+ values removed.
|
158
|
+
attr_accessor :extensions
|
159
|
+
remove_method :extensions= ;
|
160
|
+
def extensions=(ext) #:nodoc:
|
161
|
+
@extensions = [ext].flatten.compact
|
162
|
+
end
|
163
|
+
|
164
|
+
# The encoding (7bit, 8bit, quoted-printable, or base64) required to
|
165
|
+
# transport the data of this content type safely across a network, which
|
166
|
+
# roughly corresponds to Content-Transfer-Encoding. A value of +nil+ or
|
167
|
+
# <tt>:default</tt> will reset the #encoding to the #default_encoding
|
168
|
+
# for the MIME::Type. Raises ArgumentError if the encoding provided is
|
169
|
+
# invalid.
|
170
|
+
#
|
171
|
+
# If the encoding is not provided on construction, this will be either
|
172
|
+
# 'quoted-printable' (for text/* media types) and 'base64' for eveything
|
173
|
+
# else.
|
174
|
+
attr_accessor :encoding
|
175
|
+
remove_method :encoding= ;
|
176
|
+
def encoding=(enc) #:nodoc:
|
177
|
+
if enc.nil? or enc == :default
|
178
|
+
@encoding = self.default_encoding
|
179
|
+
elsif enc =~ ENCODING_RE
|
180
|
+
@encoding = enc
|
181
|
+
else
|
182
|
+
raise ArgumentError, "The encoding must be nil, :default, base64, 7bit, 8bit, or quoted-printable."
|
183
|
+
end
|
184
|
+
end
|
185
|
+
|
186
|
+
# The regexp for the operating system that this MIME::Type is specific
|
187
|
+
# to.
|
188
|
+
attr_accessor :system
|
189
|
+
remove_method :system= ;
|
190
|
+
def system=(os) #:nodoc:
|
191
|
+
if os.nil? or os.kind_of?(Regexp)
|
192
|
+
@system = os
|
193
|
+
else
|
194
|
+
@system = %r|#{os}|
|
195
|
+
end
|
196
|
+
end
|
197
|
+
# Returns the default encoding for the MIME::Type based on the media
|
198
|
+
# type.
|
199
|
+
attr_reader :default_encoding
|
200
|
+
remove_method :default_encoding
|
201
|
+
def default_encoding
|
202
|
+
(@media_type == 'text') ? 'quoted-printable' : 'base64'
|
203
|
+
end
|
204
|
+
|
205
|
+
# Returns the media type or types that should be used instead of this
|
206
|
+
# media type, if it is obsolete. If there is no replacement media type,
|
207
|
+
# or it is not obsolete, +nil+ will be returned.
|
208
|
+
attr_reader :use_instead
|
209
|
+
remove_method :use_instead
|
210
|
+
def use_instead
|
211
|
+
return nil unless @obsolete
|
212
|
+
@use_instead
|
213
|
+
end
|
214
|
+
|
215
|
+
# Returns +true+ if the media type is obsolete.
|
216
|
+
def obsolete?
|
217
|
+
@obsolete ? true : false
|
218
|
+
end
|
219
|
+
# Sets the obsolescence indicator for this media type.
|
220
|
+
attr_writer :obsolete
|
221
|
+
|
222
|
+
# The documentation for this MIME::Type. Documentation about media
|
223
|
+
# types will be found on a media type definition as a comment.
|
224
|
+
# Documentation will be found through #docs.
|
225
|
+
attr_accessor :docs
|
226
|
+
remove_method :docs= ;
|
227
|
+
def docs=(d)
|
228
|
+
if d
|
229
|
+
a = d.scan(%r{use-instead:#{MEDIA_TYPE_RE}})
|
230
|
+
|
231
|
+
if a.empty?
|
232
|
+
@use_instead = nil
|
233
|
+
else
|
234
|
+
@use_instead = a.map { |el| "#{el[0]}/#{el[1]}" }
|
235
|
+
end
|
236
|
+
end
|
237
|
+
@docs = d
|
238
|
+
end
|
239
|
+
|
240
|
+
# The encoded URL list for this MIME::Type. See #urls for more
|
241
|
+
# information.
|
242
|
+
attr_accessor :url
|
243
|
+
# The decoded URL list for this MIME::Type.
|
244
|
+
# The special URL value IANA will be translated into:
|
245
|
+
# http://www.iana.org/assignments/media-types/<mediatype>/<subtype>
|
246
|
+
#
|
247
|
+
# The special URL value RFC### will be translated into:
|
248
|
+
# http://www.rfc-editor.org/rfc/rfc###.txt
|
249
|
+
#
|
250
|
+
# The special URL value DRAFT:name will be translated into:
|
251
|
+
# https://datatracker.ietf.org/public/idindex.cgi?
|
252
|
+
# command=id_detail&filename=<name>
|
253
|
+
#
|
254
|
+
# The special URL value LTSW will be translated into:
|
255
|
+
# http://www.ltsw.se/knbase/internet/<mediatype>.htp
|
256
|
+
#
|
257
|
+
# The special URL value [token] will be translated into:
|
258
|
+
# http://www.iana.org/assignments/contact-people.htm#<token>
|
259
|
+
#
|
260
|
+
# These values will be accessible through #urls, which always returns an
|
261
|
+
# array.
|
262
|
+
def urls
|
263
|
+
@url.map do |el|
|
264
|
+
case el
|
265
|
+
when %r{^IANA$}
|
266
|
+
IANA_URL % [ @media_type, @sub_type ]
|
267
|
+
when %r{^RFC(\d+)$}
|
268
|
+
RFC_URL % $1
|
269
|
+
when %r{^DRAFT:(.+)$}
|
270
|
+
DRAFT_URL % $1
|
271
|
+
when %r{^LTSW$}
|
272
|
+
LTSW_URL % @media_type
|
273
|
+
when %r{^\{([^=]+)=([^\}]+)\}}
|
274
|
+
[$1, $2]
|
275
|
+
when %r{^\[([^=]+)=([^\]]+)\]}
|
276
|
+
[$1, CONTACT_URL % $2]
|
277
|
+
when %r{^\[([^\]]+)\]}
|
278
|
+
CONTACT_URL % $1
|
279
|
+
else
|
280
|
+
el
|
281
|
+
end
|
282
|
+
end
|
283
|
+
end
|
284
|
+
|
285
|
+
class << self
|
286
|
+
# The MIME types main- and sub-label can both start with <tt>x-</tt>,
|
287
|
+
# which indicates that it is a non-registered name. Of course, after
|
288
|
+
# registration this flag can disappear, adds to the confusing
|
289
|
+
# proliferation of MIME types. The simplified string has the
|
290
|
+
# <tt>x-</tt> removed and are translated to lowercase.
|
291
|
+
def simplified(content_type)
|
292
|
+
matchdata = MEDIA_TYPE_RE.match(content_type)
|
293
|
+
|
294
|
+
if matchdata.nil?
|
295
|
+
simplified = nil
|
296
|
+
else
|
297
|
+
media_type = matchdata.captures[0].downcase.gsub(UNREG_RE, '')
|
298
|
+
subtype = matchdata.captures[1].downcase.gsub(UNREG_RE, '')
|
299
|
+
simplified = "#{media_type}/#{subtype}"
|
300
|
+
end
|
301
|
+
simplified
|
302
|
+
end
|
303
|
+
|
304
|
+
# Creates a MIME::Type from an array in the form of:
|
305
|
+
# [type-name, [extensions], encoding, system]
|
306
|
+
#
|
307
|
+
# +extensions+, +encoding+, and +system+ are optional.
|
308
|
+
#
|
309
|
+
# MIME::Type.from_array("application/x-ruby", ['rb'], '8bit')
|
310
|
+
# MIME::Type.from_array(["application/x-ruby", ['rb'], '8bit'])
|
311
|
+
#
|
312
|
+
# These are equivalent to:
|
313
|
+
#
|
314
|
+
# MIME::Type.new('application/x-ruby') do |t|
|
315
|
+
# t.extensions = %w(rb)
|
316
|
+
# t.encoding = '8bit'
|
317
|
+
# end
|
318
|
+
def from_array(*args) #:yields MIME::Type.new:
|
319
|
+
# Dereferences the array one level, if necessary.
|
320
|
+
args = args[0] if args[0].kind_of?(Array)
|
321
|
+
|
322
|
+
if args.size.between?(1, 8)
|
323
|
+
m = MIME::Type.new(args[0]) do |t|
|
324
|
+
t.extensions = args[1] if args.size > 1
|
325
|
+
t.encoding = args[2] if args.size > 2
|
326
|
+
t.system = args[3] if args.size > 3
|
327
|
+
t.obsolete = args[4] if args.size > 4
|
328
|
+
t.docs = args[5] if args.size > 5
|
329
|
+
t.url = args[6] if args.size > 6
|
330
|
+
t.registered = args[7] if args.size > 7
|
331
|
+
end
|
332
|
+
yield m if block_given?
|
333
|
+
else
|
334
|
+
raise ArgumentError, "Array provided must contain between one and eight elements."
|
335
|
+
end
|
336
|
+
m
|
337
|
+
end
|
338
|
+
|
339
|
+
# Creates a MIME::Type from a hash. Keys are case-insensitive,
|
340
|
+
# dashes may be replaced with underscores, and the internal Symbol
|
341
|
+
# of the lowercase-underscore version can be used as well. That is,
|
342
|
+
# Content-Type can be provided as content-type, Content_Type,
|
343
|
+
# content_type, or :content_type.
|
344
|
+
#
|
345
|
+
# Known keys are <tt>Content-Type</tt>,
|
346
|
+
# <tt>Content-Transfer-Encoding</tt>, <tt>Extensions</tt>, and
|
347
|
+
# <tt>System</tt>.
|
348
|
+
#
|
349
|
+
# MIME::Type.from_hash('Content-Type' => 'text/x-yaml',
|
350
|
+
# 'Content-Transfer-Encoding' => '8bit',
|
351
|
+
# 'System' => 'linux',
|
352
|
+
# 'Extensions' => ['yaml', 'yml'])
|
353
|
+
#
|
354
|
+
# This is equivalent to:
|
355
|
+
#
|
356
|
+
# MIME::Type.new('text/x-yaml') do |t|
|
357
|
+
# t.encoding = '8bit'
|
358
|
+
# t.system = 'linux'
|
359
|
+
# t.extensions = ['yaml', 'yml']
|
360
|
+
# end
|
361
|
+
def from_hash(hash) #:yields MIME::Type.new:
|
362
|
+
type = {}
|
363
|
+
hash.each_pair do |k, v|
|
364
|
+
type[k.to_s.tr('A-Z', 'a-z').gsub(/-/, '_').to_sym] = v
|
365
|
+
end
|
366
|
+
|
367
|
+
m = MIME::Type.new(type[:content_type]) do |t|
|
368
|
+
t.extensions = type[:extensions]
|
369
|
+
t.encoding = type[:content_transfer_encoding]
|
370
|
+
t.system = type[:system]
|
371
|
+
t.obsolete = type[:obsolete]
|
372
|
+
t.docs = type[:docs]
|
373
|
+
t.url = type[:url]
|
374
|
+
t.registered = type[:registered]
|
375
|
+
end
|
376
|
+
|
377
|
+
yield m if block_given?
|
378
|
+
m
|
379
|
+
end
|
380
|
+
|
381
|
+
# Essentially a copy constructor.
|
382
|
+
#
|
383
|
+
# MIME::Type.from_mime_type(plaintext)
|
384
|
+
#
|
385
|
+
# is equivalent to:
|
386
|
+
#
|
387
|
+
# MIME::Type.new(plaintext.content_type.dup) do |t|
|
388
|
+
# t.extensions = plaintext.extensions.dup
|
389
|
+
# t.system = plaintext.system.dup
|
390
|
+
# t.encoding = plaintext.encoding.dup
|
391
|
+
# end
|
392
|
+
def from_mime_type(mime_type) #:yields the new MIME::Type:
|
393
|
+
m = MIME::Type.new(mime_type.content_type.dup) do |t|
|
394
|
+
t.extensions = mime_type.extensions.map { |e| e.dup }
|
395
|
+
t.url = mime_type.url && mime_type.url.map { |e| e.dup }
|
396
|
+
|
397
|
+
mime_type.system && t.system = mime_type.system.dup
|
398
|
+
mime_type.encoding && t.encoding = mime_type.encoding.dup
|
399
|
+
|
400
|
+
t.obsolete = mime_type.obsolete?
|
401
|
+
t.registered = mime_type.registered?
|
402
|
+
|
403
|
+
mime_type.docs && t.docs = mime_type.docs.dup
|
404
|
+
|
405
|
+
end
|
406
|
+
|
407
|
+
yield m if block_given?
|
408
|
+
end
|
409
|
+
end
|
410
|
+
|
411
|
+
# Builds a MIME::Type object from the provided MIME Content Type value
|
412
|
+
# (e.g., 'text/plain' or 'applicaton/x-eruby'). The constructed object
|
413
|
+
# is yielded to an optional block for additional configuration, such as
|
414
|
+
# associating extensions and encoding information.
|
415
|
+
def initialize(content_type) #:yields self:
|
416
|
+
matchdata = MEDIA_TYPE_RE.match(content_type)
|
417
|
+
|
418
|
+
if matchdata.nil?
|
419
|
+
raise InvalidContentType, "Invalid Content-Type provided ('#{content_type}')"
|
420
|
+
end
|
421
|
+
|
422
|
+
@content_type = content_type
|
423
|
+
@raw_media_type = matchdata.captures[0]
|
424
|
+
@raw_sub_type = matchdata.captures[1]
|
425
|
+
|
426
|
+
@simplified = MIME::Type.simplified(@content_type)
|
427
|
+
matchdata = MEDIA_TYPE_RE.match(@simplified)
|
428
|
+
@media_type = matchdata.captures[0]
|
429
|
+
@sub_type = matchdata.captures[1]
|
430
|
+
|
431
|
+
self.extensions = nil
|
432
|
+
self.encoding = :default
|
433
|
+
self.system = nil
|
434
|
+
self.registered = true
|
435
|
+
self.url = nil
|
436
|
+
self.obsolete = nil
|
437
|
+
self.docs = nil
|
438
|
+
|
439
|
+
yield self if block_given?
|
440
|
+
end
|
441
|
+
|
442
|
+
# MIME content-types which are not regestered by IANA nor defined in
|
443
|
+
# RFCs are required to start with <tt>x-</tt>. This counts as well for
|
444
|
+
# a new media type as well as a new sub-type of an existing media
|
445
|
+
# type. If either the media-type or the content-type begins with
|
446
|
+
# <tt>x-</tt>, this method will return +false+.
|
447
|
+
def registered?
|
448
|
+
if (@raw_media_type =~ UNREG_RE) || (@raw_sub_type =~ UNREG_RE)
|
449
|
+
false
|
450
|
+
else
|
451
|
+
@registered
|
452
|
+
end
|
453
|
+
end
|
454
|
+
attr_writer :registered #:nodoc:
|
455
|
+
|
456
|
+
# MIME types can be specified to be sent across a network in particular
|
457
|
+
# formats. This method returns +true+ when the MIME type encoding is set
|
458
|
+
# to <tt>base64</tt>.
|
459
|
+
def binary?
|
460
|
+
@encoding == 'base64'
|
461
|
+
end
|
462
|
+
|
463
|
+
# MIME types can be specified to be sent across a network in particular
|
464
|
+
# formats. This method returns +false+ when the MIME type encoding is
|
465
|
+
# set to <tt>base64</tt>.
|
466
|
+
def ascii?
|
467
|
+
not binary?
|
468
|
+
end
|
469
|
+
|
470
|
+
# Returns +true+ when the simplified MIME type is in the list of known
|
471
|
+
# digital signatures.
|
472
|
+
def signature?
|
473
|
+
SIGNATURES.include?(@simplified.downcase)
|
474
|
+
end
|
475
|
+
|
476
|
+
# Returns +true+ if the MIME::Type is specific to an operating system.
|
477
|
+
def system?
|
478
|
+
not @system.nil?
|
479
|
+
end
|
480
|
+
|
481
|
+
# Returns +true+ if the MIME::Type is specific to the current operating
|
482
|
+
# system as represented by RUBY_PLATFORM.
|
483
|
+
def platform?
|
484
|
+
system? and (RUBY_PLATFORM =~ @system)
|
485
|
+
end
|
486
|
+
|
487
|
+
# Returns +true+ if the MIME::Type specifies an extension list,
|
488
|
+
# indicating that it is a complete MIME::Type.
|
489
|
+
def complete?
|
490
|
+
not @extensions.empty?
|
491
|
+
end
|
492
|
+
|
493
|
+
# Returns the MIME type as a string.
|
494
|
+
def to_s
|
495
|
+
@content_type
|
496
|
+
end
|
497
|
+
|
498
|
+
# Returns the MIME type as a string for implicit conversions.
|
499
|
+
def to_str
|
500
|
+
@content_type
|
501
|
+
end
|
502
|
+
|
503
|
+
# Returns the MIME type as an array suitable for use with
|
504
|
+
# MIME::Type.from_array.
|
505
|
+
def to_a
|
506
|
+
[ @content_type, @extensions, @encoding, @system, @obsolete, @docs,
|
507
|
+
@url, registered? ]
|
508
|
+
end
|
509
|
+
|
510
|
+
# Returns the MIME type as an array suitable for use with
|
511
|
+
# MIME::Type.from_hash.
|
512
|
+
def to_hash
|
513
|
+
{ 'Content-Type' => @content_type,
|
514
|
+
'Content-Transfer-Encoding' => @encoding,
|
515
|
+
'Extensions' => @extensions,
|
516
|
+
'System' => @system,
|
517
|
+
'Obsolete' => @obsolete,
|
518
|
+
'Docs' => @docs,
|
519
|
+
'URL' => @url,
|
520
|
+
'Registered' => registered?,
|
521
|
+
}
|
522
|
+
end
|
523
|
+
end
|
524
|
+
|
525
|
+
# = MIME::Types
|
526
|
+
# MIME types are used in MIME-compliant communications, as in e-mail or
|
527
|
+
# HTTP traffic, to indicate the type of content which is transmitted.
|
528
|
+
# MIME::Types provides the ability for detailed information about MIME
|
529
|
+
# entities (provided as a set of MIME::Type objects) to be determined and
|
530
|
+
# used programmatically. There are many types defined by RFCs and vendors,
|
531
|
+
# so the list is long but not complete; don't hesitate to ask to add
|
532
|
+
# additional information. This library follows the IANA collection of MIME
|
533
|
+
# types (see below for reference).
|
534
|
+
#
|
535
|
+
# == Description
|
536
|
+
# MIME types are used in MIME entities, as in email or HTTP traffic. It is
|
537
|
+
# useful at times to have information available about MIME types (or,
|
538
|
+
# inversely, about files). A MIME::Type stores the known information about
|
539
|
+
# one MIME type.
|
540
|
+
#
|
541
|
+
# == Usage
|
542
|
+
# require 'mime/types'
|
543
|
+
#
|
544
|
+
# plaintext = MIME::Types['text/plain']
|
545
|
+
# print plaintext.media_type # => 'text'
|
546
|
+
# print plaintext.sub_type # => 'plain'
|
547
|
+
#
|
548
|
+
# puts plaintext.extensions.join(" ") # => 'asc txt c cc h hh cpp'
|
549
|
+
#
|
550
|
+
# puts plaintext.encoding # => 8bit
|
551
|
+
# puts plaintext.binary? # => false
|
552
|
+
# puts plaintext.ascii? # => true
|
553
|
+
# puts plaintext.obsolete? # => false
|
554
|
+
# puts plaintext.registered? # => true
|
555
|
+
# puts plaintext == 'text/plain' # => true
|
556
|
+
# puts MIME::Type.simplified('x-appl/x-zip') # => 'appl/zip'
|
557
|
+
#
|
558
|
+
# This module is built to conform to the MIME types of RFCs 2045 and 2231.
|
559
|
+
# It follows the official IANA registry at
|
560
|
+
# http://www.iana.org/assignments/media-types/ and
|
561
|
+
# ftp://ftp.iana.org/assignments/media-types with some unofficial types
|
562
|
+
# added from the the collection at
|
563
|
+
# http://www.ltsw.se/knbase/internet/mime.htp
|
564
|
+
#
|
565
|
+
# This is originally based on Perl MIME::Types by Mark Overmeer.
|
566
|
+
#
|
567
|
+
# = Author
|
568
|
+
# Copyright:: Copyright 2002–2013 by Austin Ziegler
|
569
|
+
# <austin@rubyforge.org>
|
570
|
+
# Version:: 1.20.1
|
571
|
+
# Licence:: See Licence.rdoc
|
572
|
+
# See Also:: http://www.iana.org/assignments/media-types/
|
573
|
+
# http://www.ltsw.se/knbase/internet/mime.htp
|
574
|
+
#
|
575
|
+
class Types
|
576
|
+
# The released version of Ruby MIME::Types
|
577
|
+
VERSION = MIME::Type::VERSION
|
578
|
+
|
579
|
+
# The data version.
|
580
|
+
attr_reader :data_version
|
581
|
+
|
582
|
+
def initialize(data_version = nil)
|
583
|
+
@type_variants = Hash.new { |h, k| h[k] = [] }
|
584
|
+
@extension_index = Hash.new { |h, k| h[k] = [] }
|
585
|
+
@data_version = data_version
|
586
|
+
end
|
587
|
+
|
588
|
+
def add_type_variant(mime_type) #:nodoc:
|
589
|
+
@type_variants[mime_type.simplified] << mime_type
|
590
|
+
end
|
591
|
+
|
592
|
+
def index_extensions(mime_type) #:nodoc:
|
593
|
+
mime_type.extensions.each { |ext| @extension_index[ext] << mime_type }
|
594
|
+
end
|
595
|
+
|
596
|
+
def defined_types #:nodoc:
|
597
|
+
@type_variants.values.flatten
|
598
|
+
end
|
599
|
+
|
600
|
+
# Returns the number of known types. A shortcut of MIME::Types[//].size.
|
601
|
+
# (Keep in mind that this is memory intensive, cache the result to spare
|
602
|
+
# resources)
|
603
|
+
def count
|
604
|
+
defined_types.size
|
605
|
+
end
|
606
|
+
|
607
|
+
def each
|
608
|
+
defined_types.each { |t| yield t }
|
609
|
+
end
|
610
|
+
|
611
|
+
@__types__ = self.new(VERSION)
|
612
|
+
|
613
|
+
# Returns a list of MIME::Type objects, which may be empty. The optional
|
614
|
+
# flag parameters are :complete (finds only complete MIME::Type objects)
|
615
|
+
# and :platform (finds only MIME::Types for the current platform). It is
|
616
|
+
# possible for multiple matches to be returned for either type (in the
|
617
|
+
# example below, 'text/plain' returns two values -- one for the general
|
618
|
+
# case, and one for VMS systems.
|
619
|
+
#
|
620
|
+
# puts "\nMIME::Types['text/plain']"
|
621
|
+
# MIME::Types['text/plain'].each { |t| puts t.to_a.join(", ") }
|
622
|
+
#
|
623
|
+
# puts "\nMIME::Types[/^image/, :complete => true]"
|
624
|
+
# MIME::Types[/^image/, :complete => true].each do |t|
|
625
|
+
# puts t.to_a.join(", ")
|
626
|
+
# end
|
627
|
+
#
|
628
|
+
# If multiple type definitions are returned, returns them sorted as
|
629
|
+
# follows:
|
630
|
+
# 1. Complete definitions sort before incomplete ones;
|
631
|
+
# 2. IANA-registered definitions sort before LTSW-recorded
|
632
|
+
# definitions.
|
633
|
+
# 3. Generic definitions sort before platform-specific ones;
|
634
|
+
# 4. Current definitions sort before obsolete ones;
|
635
|
+
# 5. Obsolete definitions with use-instead clauses sort before those
|
636
|
+
# without;
|
637
|
+
# 6. Obsolete definitions use-instead clauses are compared.
|
638
|
+
# 7. Sort on name.
|
639
|
+
def [](type_id, flags = {})
|
640
|
+
if type_id.kind_of?(Regexp)
|
641
|
+
matches = []
|
642
|
+
@type_variants.each_key do |k|
|
643
|
+
matches << @type_variants[k] if k =~ type_id
|
644
|
+
end
|
645
|
+
matches.flatten!
|
646
|
+
elsif type_id.kind_of?(MIME::Type)
|
647
|
+
matches = [type_id]
|
648
|
+
else
|
649
|
+
matches = @type_variants[MIME::Type.simplified(type_id)]
|
650
|
+
end
|
651
|
+
|
652
|
+
matches.delete_if { |e| not e.complete? } if flags[:complete]
|
653
|
+
matches.delete_if { |e| not e.platform? } if flags[:platform]
|
654
|
+
|
655
|
+
matches.sort { |a, b| a.priority_compare(b) }
|
656
|
+
end
|
657
|
+
|
658
|
+
# Return the list of MIME::Types which belongs to the file based on its
|
659
|
+
# filename extension. If +platform+ is +true+, then only file types that
|
660
|
+
# are specific to the current platform will be returned.
|
661
|
+
#
|
662
|
+
# This will always return an array.
|
663
|
+
#
|
664
|
+
# puts "MIME::Types.type_for('citydesk.xml')
|
665
|
+
# => [application/xml, text/xml]
|
666
|
+
# puts "MIME::Types.type_for('citydesk.gif')
|
667
|
+
# => [image/gif]
|
668
|
+
def type_for(filename, platform = false)
|
669
|
+
ext = filename.chomp.downcase.gsub(/.*\./o, '')
|
670
|
+
list = @extension_index[ext]
|
671
|
+
list.delete_if { |e| not e.platform? } if platform
|
672
|
+
list
|
673
|
+
end
|
674
|
+
|
675
|
+
# A synonym for MIME::Types.type_for
|
676
|
+
def of(filename, platform = false)
|
677
|
+
type_for(filename, platform)
|
678
|
+
end
|
679
|
+
|
680
|
+
# Add one or more MIME::Type objects to the set of known types. Each
|
681
|
+
# type should be experimental (e.g., 'application/x-ruby'). If the type
|
682
|
+
# is already known, a warning will be displayed.
|
683
|
+
#
|
684
|
+
# <strong>Please inform the maintainer of this module when registered
|
685
|
+
# types are missing.</strong>
|
686
|
+
def add(*types)
|
687
|
+
types.each do |mime_type|
|
688
|
+
if mime_type.kind_of? MIME::Types
|
689
|
+
add(*mime_type.defined_types)
|
690
|
+
else
|
691
|
+
if @type_variants.include?(mime_type.simplified)
|
692
|
+
if @type_variants[mime_type.simplified].include?(mime_type)
|
693
|
+
warn "Type #{mime_type} already registered as a variant of #{mime_type.simplified}." unless defined? MIME::Types::STARTUP
|
694
|
+
end
|
695
|
+
end
|
696
|
+
add_type_variant(mime_type)
|
697
|
+
index_extensions(mime_type)
|
698
|
+
end
|
699
|
+
end
|
700
|
+
end
|
701
|
+
|
702
|
+
class << self
|
703
|
+
def add_type_variant(mime_type) #:nodoc:
|
704
|
+
@__types__.add_type_variant(mime_type)
|
705
|
+
end
|
706
|
+
|
707
|
+
def index_extensions(mime_type) #:nodoc:
|
708
|
+
@__types__.index_extensions(mime_type)
|
709
|
+
end
|
710
|
+
|
711
|
+
# The regular expression used to match a file-based MIME type
|
712
|
+
# definition.
|
713
|
+
TEXT_FORMAT_RE = %r{
|
714
|
+
\A
|
715
|
+
\s*
|
716
|
+
([*])? # 0: Unregistered?
|
717
|
+
(!)? # 1: Obsolete?
|
718
|
+
(?:(\w+):)? # 2: Platform marker
|
719
|
+
#{MIME::Type::MEDIA_TYPE_RE}? # 3,4: Media type
|
720
|
+
(?:\s+@([^\s]+))? # 5: Extensions
|
721
|
+
(?:\s+:(#{MIME::Type::ENCODING_RE}))? # 6: Encoding
|
722
|
+
(?:\s+'(.+))? # 7: URL list
|
723
|
+
(?:\s+=(.+))? # 8: Documentation
|
724
|
+
(?:\s*([#].*)?)?
|
725
|
+
\s*
|
726
|
+
\z
|
727
|
+
}x
|
728
|
+
|
729
|
+
# Build the type list from a file in the format:
|
730
|
+
#
|
731
|
+
# [*][!][os:]mt/st[<ws>@ext][<ws>:enc][<ws>'url-list][<ws>=docs]
|
732
|
+
#
|
733
|
+
# == *
|
734
|
+
# An unofficial MIME type. This should be used if and only if the MIME type
|
735
|
+
# is not properly specified (that is, not under either x-type or
|
736
|
+
# vnd.name.type).
|
737
|
+
#
|
738
|
+
# == !
|
739
|
+
# An obsolete MIME type. May be used with an unofficial MIME type.
|
740
|
+
#
|
741
|
+
# == os:
|
742
|
+
# Platform-specific MIME type definition.
|
743
|
+
#
|
744
|
+
# == mt
|
745
|
+
# The media type.
|
746
|
+
#
|
747
|
+
# == st
|
748
|
+
# The media subtype.
|
749
|
+
#
|
750
|
+
# == <ws>@ext
|
751
|
+
# The list of comma-separated extensions.
|
752
|
+
#
|
753
|
+
# == <ws>:enc
|
754
|
+
# The encoding.
|
755
|
+
#
|
756
|
+
# == <ws>'url-list
|
757
|
+
# The list of comma-separated URLs.
|
758
|
+
#
|
759
|
+
# == <ws>=docs
|
760
|
+
# The documentation string.
|
761
|
+
#
|
762
|
+
# That is, everything except the media type and the subtype is optional. The
|
763
|
+
# more information that's available, though, the richer the values that can
|
764
|
+
# be provided.
|
765
|
+
def load_from_file(filename) #:nodoc:
|
766
|
+
if defined? ::Encoding
|
767
|
+
data = File.open(filename, 'r:UTF-8') { |f| f.read }
|
768
|
+
else
|
769
|
+
data = File.open(filename) { |f| f.read }
|
770
|
+
end
|
771
|
+
data = data.split($/)
|
772
|
+
mime = MIME::Types.new
|
773
|
+
data.each_with_index { |line, index|
|
774
|
+
item = line.chomp.strip
|
775
|
+
next if item.empty?
|
776
|
+
|
777
|
+
begin
|
778
|
+
m = TEXT_FORMAT_RE.match(item).captures
|
779
|
+
rescue Exception
|
780
|
+
puts "#{filename}:#{index}: Parsing error in MIME type definitions."
|
781
|
+
puts "=> #{line}"
|
782
|
+
raise
|
783
|
+
end
|
784
|
+
|
785
|
+
unregistered, obsolete, platform, mediatype, subtype, extensions,
|
786
|
+
encoding, urls, docs, comment = *m
|
787
|
+
|
788
|
+
if mediatype.nil?
|
789
|
+
if comment.nil?
|
790
|
+
puts "#{filename}:#{index}: Parsing error in MIME type definitions."
|
791
|
+
puts "=> #{line}"
|
792
|
+
raise RuntimeError
|
793
|
+
end
|
794
|
+
|
795
|
+
next
|
796
|
+
end
|
797
|
+
|
798
|
+
extensions &&= extensions.split(/,/)
|
799
|
+
urls &&= urls.split(/,/)
|
800
|
+
|
801
|
+
mime_type = MIME::Type.new("#{mediatype}/#{subtype}") do |t|
|
802
|
+
t.extensions = extensions
|
803
|
+
t.encoding = encoding
|
804
|
+
t.system = platform
|
805
|
+
t.obsolete = obsolete
|
806
|
+
t.registered = false if unregistered
|
807
|
+
t.docs = docs
|
808
|
+
t.url = urls
|
809
|
+
end
|
810
|
+
|
811
|
+
mime.add(mime_type)
|
812
|
+
}
|
813
|
+
mime
|
814
|
+
end
|
815
|
+
|
816
|
+
# Returns a list of MIME::Type objects, which may be empty. The
|
817
|
+
# optional flag parameters are :complete (finds only complete
|
818
|
+
# MIME::Type objects) and :platform (finds only MIME::Types for the
|
819
|
+
# current platform). It is possible for multiple matches to be
|
820
|
+
# returned for either type (in the example below, 'text/plain' returns
|
821
|
+
# two values -- one for the general case, and one for VMS systems.
|
822
|
+
#
|
823
|
+
# puts "\nMIME::Types['text/plain']"
|
824
|
+
# MIME::Types['text/plain'].each { |t| puts t.to_a.join(", ") }
|
825
|
+
#
|
826
|
+
# puts "\nMIME::Types[/^image/, :complete => true]"
|
827
|
+
# MIME::Types[/^image/, :complete => true].each do |t|
|
828
|
+
# puts t.to_a.join(", ")
|
829
|
+
# end
|
830
|
+
def [](type_id, flags = {})
|
831
|
+
@__types__[type_id, flags]
|
832
|
+
end
|
833
|
+
|
834
|
+
include Enumerable
|
835
|
+
|
836
|
+
def count
|
837
|
+
@__types__.count
|
838
|
+
end
|
839
|
+
|
840
|
+
def each
|
841
|
+
@__types__.each {|t| yield t }
|
842
|
+
end
|
843
|
+
|
844
|
+
# Return the list of MIME::Types which belongs to the file based on
|
845
|
+
# its filename extension. If +platform+ is +true+, then only file
|
846
|
+
# types that are specific to the current platform will be returned.
|
847
|
+
#
|
848
|
+
# This will always return an array.
|
849
|
+
#
|
850
|
+
# puts "MIME::Types.type_for('citydesk.xml')
|
851
|
+
# => [application/xml, text/xml]
|
852
|
+
# puts "MIME::Types.type_for('citydesk.gif')
|
853
|
+
# => [image/gif]
|
854
|
+
def type_for(filename, platform = false)
|
855
|
+
@__types__.type_for(filename, platform)
|
856
|
+
end
|
857
|
+
|
858
|
+
# A synonym for MIME::Types.type_for
|
859
|
+
def of(filename, platform = false)
|
860
|
+
@__types__.type_for(filename, platform)
|
861
|
+
end
|
862
|
+
|
863
|
+
# Add one or more MIME::Type objects to the set of known types. Each
|
864
|
+
# type should be experimental (e.g., 'application/x-ruby'). If the
|
865
|
+
# type is already known, a warning will be displayed.
|
866
|
+
#
|
867
|
+
# <strong>Please inform the maintainer of this module when registered
|
868
|
+
# types are missing.</strong>
|
869
|
+
def add(*types)
|
870
|
+
@__types__.add(*types)
|
871
|
+
end
|
872
|
+
end
|
873
|
+
|
874
|
+
files = Dir[File.join(File.dirname(__FILE__), 'types', '*')]
|
875
|
+
MIME::Types::STARTUP = true unless $DEBUG
|
876
|
+
files.sort.each { |file| add load_from_file(file) }
|
877
|
+
remove_const :STARTUP if defined? STARTUP
|
878
|
+
end
|
879
|
+
end
|
880
|
+
|
881
|
+
# vim: ft=ruby
|