1// Copyright (c) 2012 The Chromium Authors. All rights reserved. 2// Use of this source code is governed by a BSD-style license that can be 3// found in the LICENSE file. 4 5#ifndef NET_BASE_MIME_UTIL_H__ 6#define NET_BASE_MIME_UTIL_H__ 7 8#include <string> 9#include <vector> 10 11#include "base/files/file_path.h" 12#include "net/base/net_export.h" 13 14namespace net { 15 16// Get the mime type (if any) that is associated with the given file extension. 17// Returns true if a corresponding mime type exists. 18NET_EXPORT bool GetMimeTypeFromExtension(const base::FilePath::StringType& ext, 19 std::string* mime_type); 20 21// Get the mime type (if any) that is associated with the given file extension. 22// Returns true if a corresponding mime type exists. In this method, 23// the search for a mime type is constrained to a limited set of 24// types known to the net library, the OS/registry is not consulted. 25NET_EXPORT bool GetWellKnownMimeTypeFromExtension( 26 const base::FilePath::StringType& ext, 27 std::string* mime_type); 28 29// Get the mime type (if any) that is associated with the given file. Returns 30// true if a corresponding mime type exists. 31NET_EXPORT bool GetMimeTypeFromFile(const base::FilePath& file_path, 32 std::string* mime_type); 33 34// Get the preferred extension (if any) associated with the given mime type. 35// Returns true if a corresponding file extension exists. The extension is 36// returned without a prefixed dot, ex "html". 37NET_EXPORT bool GetPreferredExtensionForMimeType( 38 const std::string& mime_type, 39 base::FilePath::StringType* extension); 40 41// Check to see if a particular MIME type is in our list. 42NET_EXPORT bool IsSupportedImageMimeType(const std::string& mime_type); 43NET_EXPORT bool IsSupportedMediaMimeType(const std::string& mime_type); 44NET_EXPORT bool IsSupportedNonImageMimeType(const std::string& mime_type); 45NET_EXPORT bool IsUnsupportedTextMimeType(const std::string& mime_type); 46NET_EXPORT bool IsSupportedJavascriptMimeType(const std::string& mime_type); 47NET_EXPORT bool IsSupportedCertificateMimeType(const std::string& mime_type); 48 49// Convenience function. 50NET_EXPORT bool IsSupportedMimeType(const std::string& mime_type); 51 52// Returns true if this the mime_type_pattern matches a given mime-type. 53// Checks for absolute matching and wildcards. mime-types should be in 54// lower case. 55NET_EXPORT bool MatchesMimeType(const std::string& mime_type_pattern, 56 const std::string& mime_type); 57 58// Returns true if the |type_string| is a correctly-formed mime type specifier 59// with no parameter, i.e. string that matches the following ABNF (see the 60// definition of content ABNF in RFC2045 and media-type ABNF httpbis p2 61// semantics). 62// 63// token "/" token 64// 65// If |top_level_type| is non-NULL, sets it to parsed top-level type string. 66// If |subtype| is non-NULL, sets it to parsed subtype string. 67NET_EXPORT bool ParseMimeTypeWithoutParameter(const std::string& type_string, 68 std::string* top_level_type, 69 std::string* subtype); 70 71// Returns true if the |type_string| is a top-level type of any media type 72// registered with IANA media types registry at 73// http://www.iana.org/assignments/media-types/media-types.xhtml or an 74// experimental type (type with x- prefix). 75// 76// This method doesn't check that the input conforms to token ABNF, so if input 77// is experimental type strings, you need to check check that before using 78// this method. 79NET_EXPORT bool IsValidTopLevelMimeType(const std::string& type_string); 80 81// Returns true if and only if all codecs are supported, false otherwise. 82NET_EXPORT bool AreSupportedMediaCodecs(const std::vector<std::string>& codecs); 83 84// Parses a codec string, populating |codecs_out| with the prefix of each codec 85// in the string |codecs_in|. For example, passed "aaa.b.c,dd.eee", if 86// |strip| == true |codecs_out| will contain {"aaa", "dd"}, if |strip| == false 87// |codecs_out| will contain {"aaa.b.c", "dd.eee"}. 88// See http://www.ietf.org/rfc/rfc4281.txt. 89NET_EXPORT void ParseCodecString(const std::string& codecs, 90 std::vector<std::string>* codecs_out, 91 bool strip); 92 93// Check to see if a particular MIME type is in our list which only supports a 94// certain subset of codecs. 95NET_EXPORT bool IsStrictMediaMimeType(const std::string& mime_type); 96 97// Indicates that the MIME type and (possible codec string) are supported by the 98// underlying platform. 99enum SupportsType { 100 // The underlying platform is known not to support the given MIME type and 101 // codec combination. 102 IsNotSupported, 103 104 // The underlying platform is known to support the given MIME type and codec 105 // combination. 106 IsSupported, 107 108 // The underlying platform is unsure whether the given MIME type and codec 109 // combination can be rendered or not before actually trying to play it. 110 MayBeSupported 111}; 112 113// Checks the |mime_type| and |codecs| against the MIME types known to support 114// only a particular subset of codecs. 115// * Returns IsSupported if the |mime_type| is supported and all the codecs 116// within the |codecs| are supported for the |mime_type|. 117// * Returns MayBeSupported if the |mime_type| is supported and is known to 118// support only a subset of codecs, but |codecs| was empty. Also returned if 119// all the codecs in |codecs| are supported, but additional codec parameters 120// were supplied (such as profile) for which the support cannot be decided. 121// * Returns IsNotSupported if either the |mime_type| is not supported or the 122// |mime_type| is supported but at least one of the codecs within |codecs| is 123// not supported for the |mime_type|. 124NET_EXPORT SupportsType IsSupportedStrictMediaMimeType( 125 const std::string& mime_type, 126 const std::vector<std::string>& codecs); 127 128// Get the extensions associated with the given mime type. This should be passed 129// in lower case. There could be multiple extensions for a given mime type, like 130// "html,htm" for "text/html", or "txt,text,html,..." for "text/*". 131// Note that we do not erase the existing elements in the the provided vector. 132// Instead, we append the result to it. 133NET_EXPORT void GetExtensionsForMimeType( 134 const std::string& mime_type, 135 std::vector<base::FilePath::StringType>* extensions); 136 137// Test only method that removes proprietary media types and codecs from the 138// list of supported MIME types and codecs. These types and codecs must be 139// removed to ensure consistent layout test results across all Chromium 140// variations. 141NET_EXPORT void RemoveProprietaryMediaTypesAndCodecsForTests(); 142 143// Returns the IANA media type contained in |mime_type|, or an empty 144// string if |mime_type| does not specifify a known media type. 145// Supported media types are defined at: 146// http://www.iana.org/assignments/media-types/index.html 147NET_EXPORT const std::string GetIANAMediaType(const std::string& mime_type); 148 149// A list of supported certificate-related mime types. 150enum CertificateMimeType { 151#define CERTIFICATE_MIME_TYPE(name, value) CERTIFICATE_MIME_TYPE_ ## name = value, 152#include "net/base/mime_util_certificate_type_list.h" 153#undef CERTIFICATE_MIME_TYPE 154}; 155 156NET_EXPORT CertificateMimeType GetCertificateMimeTypeForMimeType( 157 const std::string& mime_type); 158 159// Prepares one value as part of a multi-part upload request. 160NET_EXPORT void AddMultipartValueForUpload(const std::string& value_name, 161 const std::string& value, 162 const std::string& mime_boundary, 163 const std::string& content_type, 164 std::string* post_data); 165 166// Adds the final delimiter to a multi-part upload request. 167NET_EXPORT void AddMultipartFinalDelimiterForUpload( 168 const std::string& mime_boundary, 169 std::string* post_data); 170 171} // namespace net 172 173#endif // NET_BASE_MIME_UTIL_H__ 174