Move URL from WebCore to WTF
[WebKit-https.git] / Source / WebKit / UIProcess / Plugins / PluginInfoStore.h
1 /*
2  * Copyright (C) 2010, 2012, 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. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #if ENABLE(NETSCAPE_PLUGIN_API)
29
30 #include "PluginModuleInfo.h"
31
32 #include <WebCore/PluginData.h>
33
34 namespace WebKit {
35
36 class PluginInfoStore;
37
38 class PluginInfoStore {
39     WTF_MAKE_NONCOPYABLE(PluginInfoStore);
40
41 public:
42     PluginInfoStore();
43
44     void setAdditionalPluginsDirectories(const Vector<String>&);
45
46     void refresh();
47     Vector<PluginModuleInfo> plugins();
48
49     // Returns the info for a plug-in that can handle the given MIME type.
50     // If the MIME type is null, the file extension of the given url will be used to infer the
51     // plug-in type. In that case, mimeType will be filled in with the right MIME type.
52     PluginModuleInfo findPlugin(String& mimeType, const URL&, WebCore::PluginData::AllowedPluginTypes = WebCore::PluginData::AllPlugins);
53
54     // Returns the info for the plug-in with the given bundle identifier.
55     PluginModuleInfo findPluginWithBundleIdentifier(const String& bundleIdentifier);
56
57     // Returns the info for the plug-in with the given path.
58     PluginModuleInfo infoForPluginWithPath(const String& pluginPath) const;
59
60     static PluginModuleLoadPolicy defaultLoadPolicyForPlugin(const PluginModuleInfo&);
61
62     bool isSupportedPlugin(const String& mimeType, const URL& pluginURL, const String& frameURLString, const URL& pageURL);
63     std::optional<Vector<WebCore::SupportedPluginIdentifier>> supportedPluginIdentifiers();
64     void addSupportedPlugin(String&& matchingDomain, String&& identifier, HashSet<String>&& mimeTypes, HashSet<String> extensions);
65     void clearSupportedPlugins() { m_supportedPlugins = std::nullopt; }
66
67     static bool shouldAllowPluginToRunUnsandboxed(const String& pluginBundleIdentifier);
68
69 private:
70     PluginModuleInfo findPluginForMIMEType(const String& mimeType, WebCore::PluginData::AllowedPluginTypes) const;
71     PluginModuleInfo findPluginForExtension(const String& extension, String& mimeType, WebCore::PluginData::AllowedPluginTypes) const;
72
73     void loadPluginsIfNecessary();
74     static void loadPlugin(Vector<PluginModuleInfo>& plugins, const String& pluginPath);
75     
76     // Platform-specific member functions:
77
78     // Returns paths to directories that should be searched for plug-ins (via pluginPathsInDirectory).
79     static Vector<String> pluginsDirectories();
80
81     // Returns paths to all plug-ins in the specified directory.
82     static Vector<String> pluginPathsInDirectory(const String& directory);
83
84     // Returns paths to individual plug-ins that won't be found via pluginsDirectories/pluginPathsInDirectory.
85     static Vector<String> individualPluginPaths();
86
87     // Load plug-in info for the plug-in with the specified path.
88     static bool getPluginInfo(const String& pluginPath, PluginModuleInfo&);
89
90     // Return whether this plug-in should be used (added to the list of plug-ins) or not.
91     static bool shouldUsePlugin(Vector<PluginModuleInfo>& alreadyLoadedPlugins, const PluginModuleInfo&);
92
93     Vector<String> m_additionalPluginsDirectories;
94     Vector<PluginModuleInfo> m_plugins;
95     bool m_pluginListIsUpToDate;
96
97     struct SupportedPlugin {
98         String matchingDomain;
99         String identifier;
100         HashSet<String> mimeTypes;
101         HashSet<String> extensions;
102     };
103     static bool isSupportedPlugin(const SupportedPlugin&, const String& mimeType, const URL& pluginURL);
104
105     std::optional<Vector<SupportedPlugin>> m_supportedPlugins;
106 };
107     
108 } // namespace WebKit
109
110 #endif // ENABLE(NETSCAPE_PLUGIN_API)