mime_negotiation.rb 3.1 KB
Newer Older
B
Bogdan Gusiev 已提交
1 2
require 'active_support/core_ext/module/attribute_accessors'

3 4 5
module ActionDispatch
  module Http
    module MimeNegotiation
6 7 8 9 10 11 12
      extend ActiveSupport::Concern

      included do
        mattr_accessor :ignore_accept_header
        self.ignore_accept_header = false
      end

13 14 15 16
      # The MIME type of the HTTP request, such as Mime::XML.
      #
      # For backward compatibility, the post \format is extracted from the
      # X-Post-Data-Format HTTP header if present.
17
      def content_mime_type
18 19 20 21 22 23 24 25 26
        @env["action_dispatch.request.content_type"] ||= begin
          if @env['CONTENT_TYPE'] =~ /^([^,\;]*)/
            Mime::Type.lookup($1.strip.downcase)
          else
            nil
          end
        end
      end

27 28 29 30
      def content_type
        content_mime_type && content_mime_type.to_s
      end

31 32 33 34 35 36
      # Returns the accepted MIME type for the request.
      def accepts
        @env["action_dispatch.request.accepts"] ||= begin
          header = @env['HTTP_ACCEPT'].to_s.strip

          if header.empty?
37
            [content_mime_type]
38 39 40 41 42 43
          else
            Mime::Type.parse(header)
          end
        end
      end

44
      # Returns the MIME type for the \format used in the request.
45 46 47
      #
      #   GET /posts/5.xml   | request.format => Mime::XML
      #   GET /posts/5.xhtml | request.format => Mime::HTML
48
      #   GET /posts/5       | request.format => Mime::HTML or MIME::JS, or request.accepts.first
49 50 51 52 53 54 55 56 57
      #
      def format(view_path = [])
        formats.first
      end

      def formats
        @env["action_dispatch.request.formats"] ||=
          if parameters[:format]
            Array(Mime[parameters[:format]])
58
          elsif use_accept_header && valid_accept_header
59
            accepts
60 61
          elsif xhr?
            [Mime::JS]
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
          else
            [Mime::HTML]
          end
      end

      # Sets the \format by string extension, which can be used to force custom formats
      # that are not controlled by the extension.
      #
      #   class ApplicationController < ActionController::Base
      #     before_filter :adjust_format_for_iphone
      #
      #     private
      #       def adjust_format_for_iphone
      #         request.format = :iphone if request.env["HTTP_USER_AGENT"][/iPhone/]
      #       end
      #   end
      def format=(extension)
        parameters[:format] = extension.to_s
        @env["action_dispatch.request.formats"] = [Mime::Type.lookup_by_extension(parameters[:format])]
      end

      # Receives an array of mimes and return the first user sent mime that
      # matches the order array.
      #
      def negotiate_mime(order)
        formats.each do |priority|
          if priority == Mime::ALL
            return order.first
          elsif order.include?(priority)
            return priority
          end
        end

        order.include?(Mime::ALL) ? formats.first : nil
      end
97 98 99 100 101 102

      protected

      BROWSER_LIKE_ACCEPTS = /,\s*\*\/\*|\*\/\*\s*,/

      def valid_accept_header
103 104
        (xhr? && (accept || content_mime_type)) ||
          (accept && accept !~ BROWSER_LIKE_ACCEPTS)
105 106 107 108 109
      end

      def use_accept_header
        !self.class.ignore_accept_header
      end
110 111
    end
  end
112
end