/usr/lib/ruby/vendor_ruby/merb-core/dispatch/request.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 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 | require 'tempfile'
module Merb
class Request
# :api: private
attr_accessor :env, :route
# :api: private
attr_reader :route_params
# by setting these to false, auto-parsing is disabled; this way you can
# do your own parsing instead
cattr_accessor :parse_multipart_params, :parse_json_params,
:parse_xml_params
self.parse_multipart_params = true
self.parse_json_params = true
self.parse_xml_params = true
# Flash, and some older browsers can't use arbitrary
# request methods -- i.e., are limited to GET/POST.
# These user-agents can make POST requests in combination
# with these overrides to participate fully in REST.
# Common examples are _method or fb_sig_request_method
# in the params, or an X-HTTP-Method-Override header
cattr_accessor :http_method_overrides
self.http_method_overrides = []
# Initialize the request object.
#
# ==== Parameters
# http_request<~params:~[], ~body:IO>::
# An object like an HTTP Request.
#
# :api: private
def initialize(rack_env)
@env = rack_env
@body = rack_env[Merb::Const::RACK_INPUT]
@route_params = {}
end
# Memoizes the new request object into env["merb.request"] so we
# can memoize things into ivars in the request
#
# ==== Parameters
# env<Hash>:: A rack environment
# *args<Array>:: Other arguments passed to the superclass
#
# ==== Returns
# Merb::Request:: The new Merb::Request
#
# :api: public
def self.new(env, *args)
if self == Merb::Request
env["merb.request"] ||= super
else
super
end
end
# Returns the controller object for initialization and dispatching the
# request.
#
# ==== Returns
# Class:: The controller class matching the routed request,
# e.g. Posts.
#
# :api: private
def controller
unless params[:controller]
raise ControllerExceptions::NotFound,
"Route matched, but route did not specify a controller.\n" +
"Did you forgot to add :controller => \"people\" or :controller " +
"segment to route definition?\nHere is what's specified:\n" +
route.inspect
end
path = [params[:namespace], params[:controller]].compact.join(Merb::Const::SLASH)
controller = path.snake_case.to_const_string
begin
Object.full_const_get(controller)
rescue NameError => e
msg = "Controller class not found for controller `#{path}'"
Merb.logger.warn!(msg)
raise ControllerExceptions::NotFound, msg
end
end
def exceptions
env["merb.exceptions"]
end
METHODS = %w{get post put delete head options}
# ==== Returns
# Symbol:: The name of the request method, e.g. :get.
#
# ==== Notes
# If the method is post, then the blocks specified in
# http_method_overrides will be checked for the masquerading method.
# The block will get the controller yielded to it. The first matching workaround wins.
# To disable this behavior, set http_method_overrides = []
#
# :api: public
def method
@method ||= begin
request_method = @env[Merb::Const::REQUEST_METHOD].downcase.to_sym
case request_method
when :get, :head, :put, :delete, :options
request_method
when :post
m = nil
self.class.http_method_overrides.each do |o|
m ||= o.call(self); break if m
end
m.downcase! if m
METHODS.include?(m) ? m.to_sym : :post
else
raise "Unknown REQUEST_METHOD: #{@env[Merb::Const::REQUEST_METHOD]}"
end
end
end
# create predicate methods for querying the REQUEST_METHOD
# get? post? head? put? etc
METHODS.each do |m|
class_eval "def #{m}?() method == :#{m} end"
end
# ==== Notes
# Find route using requested URI and merges route
# parameters (:action, :controller and named segments)
# into request params hash.
#
# :api: private
def find_route!
@route, @route_params = Merb::Router.route_for(self)
params.merge! @route_params if @route_params.is_a?(Hash)
end
# ==== Notes
# Processes the return value of a deferred router block
# and returns the current route params for the current
# request evaluation
#
# :api: private
def _process_block_return(retval)
# If the return value is an array, then it is a redirect
# so we must set the request as a redirect and extract
# the redirect params and return it as a hash so that the
# dispatcher can handle it
matched! if retval.is_a?(Array)
retval
end
# Sets the request as matched. This will abort evaluating any
# further deferred procs.
#
# :api: private
def matched!
@matched = true
end
# Checks whether or not the request has been matched to a route.
#
# :api: private
def matched?
@matched
end
# ==== Returns
# (Array, Hash):: the route params for the matched route.
#
# ==== Notes
# If the response is an Array then it is considered a direct Rack response
# to be sent back as a response. Otherwise, the route_params is a Hash with
# routing data (controller, action, et al).
#
# :api: private
def rack_response
@route_params
end
# If @route_params is an Array, then it will be the rack response.
# In this case, the request is considered handled.
#
# ==== Returns
# Boolean:: true if @route_params is an Array, false otherwise.
#
# :api: private
def handled?
@route_params.is_a?(Array)
end
# == Params
#
# Handles processing params from raw data and merging them together to get
# the final request params.
private
# ==== Returns
# Hash:: Parameters passed from the URL like ?blah=hello.
#
# :api: private
def query_params
@query_params ||= Merb::Parse.query(query_string || '')
end
# Parameters passed in the body of the request. Ajax calls from
# prototype.js and other libraries pass content this way.
#
# ==== Returns
# Hash:: The parameters passed in the body.
#
# :api: private
def body_params
@body_params ||= begin
if content_type && content_type.match(Merb::Const::FORM_URL_ENCODED_REGEXP) # or content_type.nil?
Merb::Parse.query(raw_post)
end
end
end
# ==== Returns
# Mash::
# The parameters gathered from the query string and the request body,
# with parameters in the body taking precedence.
#
# :api: private
def body_and_query_params
# ^-- FIXME a better name for this method
@body_and_query_params ||= begin
h = query_params
h.merge!(body_params) if body_params
h.to_mash
end
end
# ==== Raises
# ControllerExceptions::MultiPartParseError::
# Unable to parse the multipart form data.
#
# ==== Returns
# Hash:: The parsed multipart parameters.
#
# :api: private
def multipart_params
@multipart_params ||=
begin
# if the content-type is multipart
# parse the multipart. Otherwise return {}
if (Merb::Const::MULTIPART_REGEXP =~ content_type)
Merb::Parse.multipart(@body, $1, content_length)
else
{}
end
rescue ControllerExceptions::MultiPartParseError => e
@multipart_params = {}
raise e
end
end
# ==== Returns
# Hash:: Parameters from body if this is a JSON request.
#
# ==== Notes
# If the JSON object parses as a Hash, it will be merged with the
# parameters hash. If it parses to anything else (such as an Array, or
# if it inflates to an Object) it will be accessible via the inflated_object
# parameter.
#
# :api: private
def json_params
@json_params ||= begin
if Merb::Const::JSON_MIME_TYPE_REGEXP.match(content_type)
begin
jobj = JSON.parse(raw_post)
jobj = jobj.to_mash if jobj.is_a?(Hash)
rescue JSON::ParserError
jobj = Mash.new
end
jobj.is_a?(Hash) ? jobj : { :inflated_object => jobj }
end
end
end
# ==== Returns
# Hash:: Parameters from body if this is an XML request.
#
# :api: private
def xml_params
@xml_params ||= begin
if Merb::Const::XML_MIME_TYPE_REGEXP.match(content_type)
Hash.from_xml(raw_post) rescue Mash.new
end
end
end
public
# ==== Returns
# Mash:: All request parameters.
#
# ==== Notes
# The order of precedence for the params is XML, JSON, multipart, body and
# request string.
#
# :api: public
def params
@params ||= begin
h = body_and_query_params.merge(route_params)
h.merge!(multipart_params) if self.class.parse_multipart_params && multipart_params
h.merge!(json_params) if self.class.parse_json_params && json_params
h.merge!(xml_params) if self.class.parse_xml_params && xml_params
h
end
end
# ==== Returns
# String:: Returns the redirect message Base64 unencoded.
#
# :api: public
def message
return {} unless params[:_message]
begin
Marshal.load(params[:_message].unpack("m").first)
rescue ArgumentError, TypeError
{}
end
end
# ==== Notes
# Resets the params to a nil value.
#
# :api: private
def reset_params!
@params = nil
end
# ==== Returns
# String:: The raw post.
#
# :api: private
def raw_post
@body.rewind if @body.respond_to?(:rewind)
@raw_post ||= @body.read
end
# ==== Returns
# Boolean:: If the request is an XML HTTP request.
#
# :api: public
def xml_http_request?
not Merb::Const::XML_HTTP_REQUEST_REGEXP.match(@env[Merb::Const::HTTP_X_REQUESTED_WITH]).nil?
end
alias xhr? :xml_http_request?
alias ajax? :xml_http_request?
# ==== Returns
# String:: The remote IP address.
#
# :api: public
def remote_ip
return @env[Merb::Const::HTTP_CLIENT_IP] if @env.include?(Merb::Const::HTTP_CLIENT_IP)
if @env.include?(Merb::Const::HTTP_X_FORWARDED_FOR) then
remote_ips = @env[Merb::Const::HTTP_X_FORWARDED_FOR].split(',').reject do |ip|
ip =~ Merb::Const::LOCAL_IP_REGEXP
end
return remote_ips.first.strip unless remote_ips.empty?
end
return @env[Merb::Const::REMOTE_ADDR]
end
# ==== Returns
# String::
# The protocol, i.e. either "https" or "http" depending on the
# HTTPS header.
#
# :api: public
def protocol
ssl? ? Merb::Const::HTTPS : Merb::Const::HTTP
end
# ==== Returns
# Boolean::: True if the request is an SSL request.
#
# :api: public
def ssl?
@env[Merb::Const::UPCASE_HTTPS] == 'on' || @env[Merb::Const::HTTP_X_FORWARDED_PROTO] == Merb::Const::HTTPS
end
# ==== Returns
# String:: The HTTP referer.
#
# :api: public
def referer
@env[Merb::Const::HTTP_REFERER]
end
# ==== Returns
# String:: The full URI, including protocol and host
#
# :api: public
def full_uri
protocol + "://" + host + uri
end
# ==== Returns
# String:: The request URI.
#
# :api: public
def uri
@env[Merb::Const::REQUEST_PATH] || @env[Merb::Const::REQUEST_URI] || path_info
end
# ==== Returns
# String:: The HTTP user agent.
#
# :api: public
def user_agent
@env[Merb::Const::HTTP_USER_AGENT]
end
# ==== Returns
# String:: The server name.
#
# :api: public
def server_name
@env[Merb::Const::SERVER_NAME]
end
# ==== Returns
# String:: The accepted encodings.
#
# :api: private
def accept_encoding
@env[Merb::Const::HTTP_ACCEPT_ENCODING]
end
# ==== Returns
# String:: The script name.
#
# :api: public
def script_name
@env[Merb::Const::SCRIPT_NAME]
end
# ==== Returns
# String:: HTTP cache control.
#
# :api: public
def cache_control
@env[Merb::Const::HTTP_CACHE_CONTROL]
end
# ==== Returns
# String:: The accepted language.
#
# :api: public
def accept_language
@env[Merb::Const::HTTP_ACCEPT_LANGUAGE]
end
# ==== Returns
# String:: The server software.
#
# :api: public
def server_software
@env[Merb::Const::SERVER_SOFTWARE]
end
# ==== Returns
# String:: Value of HTTP_KEEP_ALIVE.
#
# :api: public
def keep_alive
@env[Merb::Const::HTTP_KEEP_ALIVE]
end
# ==== Returns
# String:: The accepted character sets.
#
# :api: public
def accept_charset
@env[Merb::Const::HTTP_ACCEPT_CHARSET]
end
# ==== Returns
# String:: The HTTP version
#
# :api: private
def version
@env[Merb::Const::HTTP_VERSION]
end
# ==== Returns
# String:: The gateway.
#
# :api: public
def gateway
@env[Merb::Const::GATEWAY_INTERFACE]
end
# ==== Returns
# String:: The accepted response types. Defaults to "*/*".
#
# :api: private
def accept
@env[Merb::Const::HTTP_ACCEPT].blank? ? "*/*" : @env[Merb::Const::HTTP_ACCEPT]
end
# ==== Returns
# String:: The HTTP connection.
#
# :api: private
def connection
@env[Merb::Const::HTTP_CONNECTION]
end
# ==== Returns
# String:: The query string.
#
# :api: private
def query_string
@env[Merb::Const::QUERY_STRING]
end
# ==== Returns
# String:: The request content type.
#
# :api: private
def content_type
@env[Merb::Const::UPCASE_CONTENT_TYPE]
end
# ==== Returns
# Fixnum:: The request content length.
#
# :api: public
def content_length
@content_length ||= @env[Merb::Const::CONTENT_LENGTH].to_i
end
# ==== Returns
# String::
# The URI without the query string. Strips trailing "/" and reduces
# duplicate "/" to a single "/".
#
# :api: public
def path
# Merb::Const::SLASH is /
# Merb::Const::QUESTION_MARK is ?
path = (uri.empty? ? Merb::Const::SLASH : uri.split(Merb::Const::QUESTION_MARK).first).squeeze(Merb::Const::SLASH)
path = path[0..-2] if (path[-1] == ?/) && path.size > 1
path
end
# ==== Returns
# String:: The path info.
#
# :api: public
def path_info
@path_info ||= Merb::Parse.unescape(@env[Merb::Const::PATH_INFO])
end
# ==== Returns
# Fixnum:: The server port.
#
# :api: public
def port
@env[Merb::Const::SERVER_PORT].to_i
end
# ==== Returns
# String:: The full hostname including the port.
#
# :api: public
def host
@env[Merb::Const::HTTP_X_FORWARDED_HOST] || @env[Merb::Const::HTTP_HOST] ||
@env[Merb::Const::SERVER_NAME]
end
# ==== Parameters
# tld_length<Fixnum>::
# Number of domains levels to inlclude in the top level domain. Defaults
# to 1.
#
# ==== Returns
# Array:: All the subdomain parts of the host.
#
# :api: public
def subdomains(tld_length = 1)
parts = host.split(Merb::Const::DOT)
parts[0..-(tld_length+2)]
end
# ==== Parameters
# tld_length<Fixnum>::
# Number of domains levels to inlclude in the top level domain. Defaults
# to 1.
#
# ==== Returns
# String:: The full domain name without the port number.
#
# :api: public
def domain(tld_length = 1)
host.split(Merb::Const::DOT).last(1 + tld_length).join(Merb::Const::DOT).sub(/:\d+$/,'')
end
# ==== Returns
# Value of If-None-Match request header.
#
# :api: private
def if_none_match
@env[Merb::Const::HTTP_IF_NONE_MATCH]
end
# ==== Returns
# Value of If-Modified-Since request header.
#
# :api: private
def if_modified_since
if time = @env[Merb::Const::HTTP_IF_MODIFIED_SINCE]
Time.rfc2822(time)
end
end
end
end
|