/usr/lib/ruby/vendor_ruby/merb-core/controller/mixins/responder.rb is in ruby-merb-core 1.1.3+dfsg-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 | require 'enumerator'
require 'merb-core/controller/mime'
module Merb
# The ResponderMixin adds methods that help you manage what
# formats your controllers have available, determine what format(s)
# the client requested and is capable of handling, and perform
# content negotiation to pick the proper content format to
# deliver.
#
# If you hear someone say "Use provides" they're talking about the
# Responder. If you hear someone ask "What happened to respond_to?"
# it was replaced by provides and the other Responder methods.
#
# == A simple example
#
# The best way to understand how all of these pieces fit together is
# with an example. Here's a simple web-service ready resource that
# provides a list of all the widgets we know about. The widget list is
# available in 3 formats: :html (the default), plus :xml and :text.
#
# class Widgets < Application
# provides :html # This is the default, but you can
# # be explicit if you like.
# provides :xml, :text
#
# def index
# @widgets = Widget.fetch
# render @widgets
# end
# end
#
# Let's look at some example requests for this list of widgets. We'll
# assume they're all GET requests, but that's only to make the examples
# easier; this works for the full set of RESTful methods.
#
# 1. The simplest case, /widgets.html
# Since the request includes a specific format (.html) we know
# what format to return. Since :html is in our list of provided
# formats, that's what we'll return. +render+ will look
# for an index.html.erb (or another template format
# like index.html.mab; see the documentation on Template engines)
#
# 2. Almost as simple, /widgets.xml
# This is very similar. They want :xml, we have :xml, so
# that's what they get. If +render+ doesn't find an
# index.xml.builder or similar template, it will call +to_xml+
# on @widgets. This may or may not do something useful, but you can
# see how it works.
#
# 3. A browser request for /widgets
# This time the URL doesn't say what format is being requested, so
# we'll look to the HTTP Accept: header. If it's '*/*' (anything),
# we'll use the first format on our list, :html by default.
#
# If it parses to a list of accepted formats, we'll look through
# them, in order, until we find one we have available. If we find
# one, we'll use that. Otherwise, we can't fulfill the request:
# they asked for a format we don't have. So we raise
# 406: Not Acceptable.
#
# == A more complex example
#
# Sometimes you don't have the same code to handle each available
# format. Sometimes you need to load different data to serve
# /widgets.xml versus /widgets.txt. In that case, you can use
# +content_type+ to determine what format will be delivered.
#
# class Widgets < Application
# def action1
# if content_type == :text
# Widget.load_text_formatted(params[:id])
# else
# render
# end
# end
#
# def action2
# case content_type
# when :html
# handle_html()
# when :xml
# handle_xml()
# when :text
# handle_text()
# else
# render
# end
# end
# end
#
# You can do any standard Ruby flow control using +content_type+. If
# you don't call it yourself, it will be called (triggering content
# negotiation) by +render+.
#
# Once +content_type+ has been called, the output format is frozen,
# and none of the provides methods can be used.
module ResponderMixin
TYPES = Dictionary.new
MIMES = {}
MIME_MUTEX = Mutex.new
ACCEPT_RESULTS = {}
class ContentTypeAlreadySet < StandardError; end
# ==== Parameters
# base<Module>:: The module that ResponderMixin was mixed into
#
# :api: private
def self.included(base)
base.extend(ClassMethods)
base.class_eval do
class_inheritable_accessor :class_provided_formats
self.class_provided_formats = []
end
base.reset_provides
end
module ClassMethods
# Adds symbols representing formats to the controller's default list of
# provided_formats. These will apply to every action in the controller,
# unless modified in the action. If the last argument is a Hash or an
# Array, these are regarded as arguments to pass to the to_<mime_type>
# method as needed.
#
# ==== Parameters
# *formats<Symbol>::
# A list of mime-types that the controller should provide.
#
# ==== Returns
# Array[Symbol]:: List of formats passed in.
#
# ==== Examples
# provides :html, :xml
#
# :api: public
def provides(*formats)
self.class_provided_formats |= formats
end
# This class should only provide the formats listed here, despite any
# other definitions previously or in superclasses.
#
# ==== Parameters
# *formats<Symbol>:: Registered mime-types.
#
# ==== Returns
# Array[Symbol]:: List of formats passed in.
#
# :api: public
def only_provides(*formats)
clear_provides
provides(*formats)
end
# This class should not provide any of this list of formats, despite any.
# other definitions previously or in superclasses.
#
# ==== Parameters
# *formats<Symbol>:: Registered mime-types.
#
# ==== Returns
# Array[Symbol]::
# List of formats that remain after removing the ones not to provide.
#
# :api: public
def does_not_provide(*formats)
self.class_provided_formats -= formats
end
# Clear the list of provides.
#
# ==== Returns
# Array:: An empty Array.
#
# :api: public
def clear_provides
self.class_provided_formats.clear
end
# Reset the list of provides to include only :html.
#
# ==== Returns
# Array[Symbol]:: [:html].
#
# :api: public
def reset_provides
only_provides(:html)
end
end
# ==== Returns
# Array[Symbol]::
# The current list of formats provided for this instance of the
# controller. It starts with what has been set in the controller (or
# :html by default) but can be modifed on a per-action basis.
#
# :api: private
def _provided_formats
@_provided_formats ||= class_provided_formats.dup
end
# Adds formats to the list of provided formats for this particular request.
# Usually used to add formats to a single action. See also the
# controller-level provides that affects all actions in a controller.
#
# ==== Parameters
# *formats<Symbol>::
# A list of formats to add to the per-action list of provided formats.
#
# ==== Raises
# Merb::ResponderMixin::ContentTypeAlreadySet::
# Content negotiation already occured, and the content_type is set.
#
# ==== Returns
# Array[Symbol]:: List of formats passed in.
#
# :api: public
def provides(*formats)
if @_content_type
raise ContentTypeAlreadySet, "Cannot modify provided_formats because content_type has already been set"
end
@_provided_formats = self._provided_formats | formats # merges with class_provided_formats if not already
end
# Sets list of provided formats for this particular request. Usually used
# to limit formats to a single action. See also the controller-level
# only_provides that affects all actions in a controller.
#
# ==== Parameters
# *formats<Symbol>::
# A list of formats to use as the per-action list of provided formats.
#
# ==== Returns
# Array[Symbol]:: List of formats passed in.
#
# :api: public
def only_provides(*formats)
@_provided_formats = []
provides(*formats)
end
# Removes formats from the list of provided formats for this particular
# request. Usually used to remove formats from a single action. See
# also the controller-level does_not_provide that affects all actions in a
# controller.
#
# ==== Parameters
# *formats<Symbol>:: Registered mime-type
#
# ==== Returns
# Array[Symbol]::
# List of formats that remain after removing the ones not to provide.
#
# :api: public
def does_not_provide(*formats)
@_provided_formats -= formats.flatten
end
def _accept_types
accept = request.accept
MIME_MUTEX.synchronize do
return ACCEPT_RESULTS[accept] if ACCEPT_RESULTS[accept]
end
types = request.accept.split(Merb::Const::ACCEPT_SPLIT).map do |entry|
entry =~ Merb::Const::MEDIA_RANGE
media_range, quality = $1, $3
kind, sub_type = media_range.split(Merb::Const::SLASH_SPLIT)
mime_sym = Merb.available_accepts[media_range]
mime = Merb.available_mime_types[mime_sym]
(quality ||= 0.0) if media_range == "*/*"
quality = quality ? (quality.to_f * 100).to_i : 100
quality *= (mime && mime[:default_quality] || 1)
[quality, mime_sym, media_range, kind, sub_type, mime]
end
accepts = types.sort_by {|x| x.first }.reverse!.map! {|x| x[1]}
MIME_MUTEX.synchronize do
ACCEPT_RESULTS[accept] = accepts.freeze
end
accepts
end
# Do the content negotiation:
# 1. if params[:format] is there, and provided, use it
# 2. Parse the Accept header
# 3. If it's */*, use the first provided format
# 4. Look for one that is provided, in order of request
# 5. Raise 406 if none found
#
# :api: private
def _perform_content_negotiation
if fmt = params[:format] and !fmt.blank?
accepts = [fmt.to_sym]
else
accepts = _accept_types
end
provided_formats = _provided_formats
specifics = accepts & provided_formats
return specifics.first unless specifics.length == 0
return provided_formats.first if accepts.include?(:all) && !provided_formats.empty?
message = "A format (%s) that isn't provided (%s) has been requested. "
message += "Make sure the action provides the format, and be "
message += "careful of before filters which won't recognize "
message += "formats provided within actions."
raise Merb::ControllerExceptions::NotAcceptable,
(message % [accepts.join(', '), provided_formats.join(', ')])
end
# Returns the output format for this request, based on the
# provided formats, <tt>params[:format]</tt> and the client's HTTP
# Accept header.
#
# The first time this is called, it triggers content negotiation
# and caches the value. Once you call +content_type+ you can
# not set or change the list of provided formats.
#
# Called automatically by +render+, so you should only call it if
# you need the value, not to trigger content negotiation.
#
# ==== Parameters
# fmt<String>::
# An optional format to use instead of performing content negotiation.
# This can be used to pass in the values of opts[:format] from the
# render function to short-circuit content-negotiation when it's not
# necessary. This optional parameter should not be considered part
# of the public API.
#
# ==== Returns
# Symbol:: The content-type that will be used for this controller.
#
# :api: public
def content_type(fmt = nil)
self.content_type = (fmt || _perform_content_negotiation) unless @_content_type
@_content_type
end
# Sets the content type of the current response to a value based on
# a passed in key. The Content-Type header will be set to the first
# registered header for the mime-type.
#
# ==== Parameters
# type<Symbol>:: The content type.
#
# ==== Raises
# ArgumentError:: type is not in the list of registered mime-types.
#
# ==== Returns
# Symbol:: The content-type that was passed in.
#
# :api: plugin
def content_type=(type)
unless Merb.available_mime_types.has_key?(type)
raise Merb::ControllerExceptions::NotAcceptable.new("Unknown content_type for response: #{type}")
end
@_content_type = type
mime = Merb.available_mime_types[type]
headers["Content-Type"] = mime[:content_type]
# merge any format specific response headers
mime[:response_headers].each { |k,v| headers[k] ||= v }
# if given, use a block to finetune any runtime headers
mime[:response_block].call(self) if mime[:response_block]
@_content_type
end
end
class Responder
# Parses the raw accept header into an array of sorted AcceptType objects.
#
# ==== Parameters
# accept_header<~to_s>:: The raw accept header.
#
# ==== Returns
# Array[AcceptType]:: The accepted types.
#
# @private
def self.parse(accept_header)
headers = accept_header.split(/,/)
idx, list = 0, []
while idx < headers.size
list << AcceptType.new(headers[idx], idx)
idx += 1
end
list.sort
end
end
class AcceptType
attr_reader :media_range, :quality, :index, :type, :sub_type
# ==== Parameters
# entry<String>:: The accept type pattern
# index<Fixnum>::
# The index used for sorting accept types. A lower value indicates higher
# priority.
#
# :api: private
def initialize(entry,index)
@index = index
entry =~ /\s*([^;\s]*)\s*(;\s*q=\s*(.*))?/
@media_range, quality = $1, $3
@type, @sub_type = @media_range.split(%r{/})
(quality ||= 0.0) if @media_range == "*/*"
@quality = quality ? (quality.to_f * 100).to_i : 100
@quality *= (mime && mime[:default_quality] || 1)
end
# Compares two accept types for sorting purposes.
#
# ==== Parameters
# entry<AcceptType>:: The accept type to compare.
#
# ==== Returns
# Fixnum::
# -1, 0 or 1, depending on whether entry has a lower, equal or higher
# priority than the accept type being compared.
#
# :api: private
def <=>(entry)
if entry.quality == quality
@index <=> entry.index
else
entry.quality <=> @quality
end
end
# ==== Parameters
# entry<AcceptType>:: The accept type to compare.
#
# ==== Returns
# Boolean::
# True if the accept types are equal, i.e. if the synonyms for this
# accept type includes the entry media range.
#
# :api: private
def eql?(entry)
synonyms.include?(entry.media_range)
end
# An alias for eql?.
#
# :api: private
def ==(entry); eql?(entry); end
# ==== Returns
# Fixnum:: A hash based on the super range.
#
# :api: private
def hash; super_range.hash; end
# ==== Returns
# Array[String]::
# All Accept header values, such as "text/html", that match this type.
#
# :api: private
def synonyms
return @syns if @syns
if _mime = mime
@syns = _mime[:accepts]
else
@syns = []
end
end
# :api: private
def mime
@mime ||= Merb.available_mime_types[Merb::ResponderMixin::MIMES[@media_range]]
end
# ==== Returns
# String::
# The primary media range for this accept type, i.e. either the first
# synonym or, if none exist, the media range.
#
# :api: private
def super_range
synonyms.first || @media_range
end
# ==== Returns
# Symbol: The type as a symbol, e.g. :html.
#
# :api: private
def to_sym
Merb.available_mime_types.select{|k,v|
v[:accepts] == synonyms || v[:accepts][0] == synonyms[0]}.flatten.first
end
# ==== Returns
# String:: The accept type as a string, i.e. the media range.
#
# :api: private
def to_s
@media_range
end
end
end
|