Unreviewed, rolling out r230117.
[WebKit.git] / Source / WebCore / platform / MIMETypeRegistry.h
1 /*
2  * Copyright (C) 2006-2016 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include <wtf/HashSet.h>
29 #include <wtf/Vector.h>
30 #include <wtf/text/StringHash.h>
31
32 namespace WebCore {
33
34 class MIMETypeRegistry {
35 public:
36     WEBCORE_EXPORT static String getMIMETypeForExtension(const String& extension);
37
38     // FIXME: WebKit coding style says we should not have the word "get" in the names of these functions.
39     static Vector<String> getExtensionsForMIMEType(const String& type);
40     WEBCORE_EXPORT static String getPreferredExtensionForMIMEType(const String& type);
41     static String getMediaMIMETypeForExtension(const String& extension);
42     static Vector<String> getMediaMIMETypesForExtension(const String& extension);
43
44     static String getMIMETypeForPath(const String& path);
45
46     // Check to see if a MIME type is suitable for being loaded inline as an
47     // image (e.g., <img> tags).
48     WEBCORE_EXPORT static bool isSupportedImageMIMEType(const String& mimeType);
49
50     // Check to see if a MIME type is suitable for being loaded as an image, including SVG and Video (where supported).
51     WEBCORE_EXPORT static bool isSupportedImageVideoOrSVGMIMEType(const String& mimeType);
52
53     // Check to see if a MIME type is suitable for being loaded as an image
54     // document in a frame.
55     WEBCORE_EXPORT static bool isSupportedImageResourceMIMEType(const String& mimeType);
56
57     // Check to see if a MIME type is suitable for being encoded.
58     static bool isSupportedImageMIMETypeForEncoding(const String& mimeType);
59
60     // Check to see if a MIME type is suitable for being loaded as a JavaScript or JSON resource.
61     WEBCORE_EXPORT static bool isSupportedJavaScriptMIMEType(const String& mimeType);
62     WEBCORE_EXPORT static bool isSupportedJSONMIMEType(const String& mimeType);
63
64     // Check to see if a MIME type is suitable for being loaded as a style sheet.
65     static bool isSupportedStyleSheetMIMEType(const String& mimeType);
66
67     // Check to see if a MIME type is suitable for being loaded as a font.
68     static bool isSupportedFontMIMEType(const String& mimeType);
69
70     // Check to see if a non-image MIME type is suitable for being loaded as a
71     // document in a frame. Does not include supported JavaScript and JSON MIME types.
72     WEBCORE_EXPORT static bool isSupportedNonImageMIMEType(const String& mimeType);
73
74     // Check to see if a MIME type is suitable for being loaded using <video> and <audio>.
75     WEBCORE_EXPORT static bool isSupportedMediaMIMEType(const String& mimeType);
76
77     // Check to see if a MIME type is suitable for being loaded using <track>>.
78     WEBCORE_EXPORT static bool isSupportedTextTrackMIMEType(const String& mimeType);
79
80     // Check to see if a MIME type is a valid Java applet mime type.
81     WEBCORE_EXPORT static bool isJavaAppletMIMEType(const String& mimeType);
82
83     // Check to see if a MIME type is a plugin implemented by the browser.
84     static bool isApplicationPluginMIMEType(const String& mimeType);
85
86     // Check to see if a MIME type is one of the common PDF/PS types.
87     static bool isPDFMIMEType(const String& mimeType);
88     static bool isPostScriptMIMEType(const String& mimeType);
89     WEBCORE_EXPORT static bool isPDFOrPostScriptMIMEType(const String& mimeType);
90
91     // Check to see if a MIME type is suitable for being shown inside a page.
92     // Returns true if any of isSupportedImageMIMEType(), isSupportedNonImageMIMEType(),
93     // isSupportedMediaMIMEType(), isSupportedJavaScriptMIMEType(), isSupportedJSONMIMEType(),
94     // returns true or if the given MIME type begins with "text/" and
95     // isUnsupportedTextMIMEType() returns false.
96     WEBCORE_EXPORT static bool canShowMIMEType(const String& mimeType);
97
98     // Check to see if a MIME type is one where an XML document should be created
99     // rather than an HTML document.
100     WEBCORE_EXPORT static bool isXMLMIMEType(const String& mimeType);
101
102     // Used in page load algorithm to decide whether to display as a text
103     // document in a frame. Not a good idea to use elsewhere, because that code
104     // makes this test is after many other tests are done on the MIME type.
105     WEBCORE_EXPORT static bool isTextMIMEType(const String& mimeType);
106
107     // FIXME: WebKit coding style says we should not have the word "get" in the names of these functions.
108     // FIXME: Would be nice to find a way to avoid exposing these sets, even worse exposing non-const references.
109     WEBCORE_EXPORT static HashSet<String, ASCIICaseInsensitiveHash>& getSupportedNonImageMIMETypes();
110
111     WEBCORE_EXPORT const static HashSet<String, ASCIICaseInsensitiveHash>& getSupportedImageMIMETypes();
112     const static HashSet<String, ASCIICaseInsensitiveHash>& getSupportedImageResourceMIMETypes();
113     WEBCORE_EXPORT const static HashSet<String, ASCIICaseInsensitiveHash>& getSupportedMediaMIMETypes();
114     WEBCORE_EXPORT const static HashSet<String, ASCIICaseInsensitiveHash>& getPDFMIMETypes();
115     WEBCORE_EXPORT const static HashSet<String, ASCIICaseInsensitiveHash>& getUnsupportedTextMIMETypes();
116
117     // FIXME: WebKit coding style says we should not have the word "get" in the name of this function.
118     // FIXME: Unclear what the concept of a normalized MIME type is; currently it's a platform-specific notion.
119     static String getNormalizedMIMEType(const String&);
120
121     WEBCORE_EXPORT static String appendFileExtensionIfNecessary(const String& filename, const String& mimeType);
122
123 private:
124     // Check to see if the MIME type is not suitable for being loaded as a text
125     // document in a frame. Only valid for MIME types begining with "text/".
126     static bool isUnsupportedTextMIMEType(const String& mimeType);
127 };
128
129 WEBCORE_EXPORT const String& defaultMIMEType();
130
131 } // namespace WebCore