blob: 13bbd797291ed84d3727e7ec0c6135fe10989fcf [file] [log] [blame]
/*
Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies)
Copyright (C) 2015-2022 Apple Inc. All rights reserved.
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#pragma once
#include <wtf/EnumTraits.h>
#include <wtf/RefCounted.h>
#include <wtf/URL.h>
#include <wtf/Vector.h>
#include <wtf/text/StringHash.h>
#include <wtf/text/WTFString.h>
namespace WebCore {
class Page;
enum class PluginLoadClientPolicy : uint8_t {
// No client-specific plug-in load policy has been defined. The plug-in should be visible in navigator.plugins and WebKit should synchronously
// ask the client whether the plug-in should be loaded.
Undefined = 0,
// The plug-in module should be blocked from being instantiated. The plug-in should be hidden in navigator.plugins.
Block,
// WebKit should synchronously ask the client whether the plug-in should be loaded. The plug-in should be visible in navigator.plugins.
Ask,
// The plug-in module may be loaded if WebKit is not blocking it.
Allow,
// The plug-in module should be loaded irrespective of whether WebKit has asked it to be blocked.
AllowAlways,
};
struct MimeClassInfo {
AtomString type;
String desc;
Vector<String> extensions;
};
inline bool operator==(const MimeClassInfo& a, const MimeClassInfo& b)
{
return a.type == b.type && a.desc == b.desc && a.extensions == b.extensions;
}
struct PluginInfo {
String name;
String file;
String desc;
Vector<MimeClassInfo> mimes;
bool isApplicationPlugin { false };
PluginLoadClientPolicy clientLoadPolicy { PluginLoadClientPolicy::Undefined };
String bundleIdentifier;
#if PLATFORM(MAC)
String versionString;
#endif
};
inline bool operator==(PluginInfo& a, PluginInfo& b)
{
bool result = a.name == b.name && a.file == b.file && a.desc == b.desc && a.mimes == b.mimes && a.isApplicationPlugin == b.isApplicationPlugin && a.clientLoadPolicy == b.clientLoadPolicy && a.bundleIdentifier == b.bundleIdentifier;
#if PLATFORM(MAC)
result = result && a.versionString == b.versionString;
#endif
return result;
}
struct SupportedPluginIdentifier {
String matchingDomain;
String pluginIdentifier;
template<class Encoder> void encode(Encoder&) const;
template<class Decoder> static std::optional<SupportedPluginIdentifier> decode(Decoder&);
};
// FIXME: merge with PluginDatabase in the future
class PluginData : public RefCounted<PluginData> {
public:
static Ref<PluginData> create(Page& page) { return adoptRef(*new PluginData(page)); }
const Vector<PluginInfo>& plugins() const { return m_plugins; }
WEBCORE_EXPORT const Vector<PluginInfo>& webVisiblePlugins() const;
std::pair<Vector<PluginInfo>, Vector<PluginInfo>> publiclyVisiblePluginsAndAdditionalWebVisiblePlugins() const;
WEBCORE_EXPORT Vector<MimeClassInfo> webVisibleMimeTypes() const;
enum AllowedPluginTypes {
AllPlugins,
OnlyApplicationPlugins
};
WEBCORE_EXPORT bool supportsMimeType(const String& mimeType, const AllowedPluginTypes) const;
WEBCORE_EXPORT bool supportsWebVisibleMimeType(const String& mimeType, const AllowedPluginTypes) const;
WEBCORE_EXPORT bool supportsWebVisibleMimeTypeForURL(const String& mimeType, const AllowedPluginTypes, const URL&) const;
String pluginFileForWebVisibleMimeType(const String& mimeType) const;
private:
explicit PluginData(Page&);
void initPlugins();
protected:
Page& m_page;
Vector<PluginInfo> m_plugins;
std::optional<Vector<SupportedPluginIdentifier>> m_supportedPluginIdentifiers;
struct CachedVisiblePlugins {
URL pageURL;
std::optional<Vector<PluginInfo>> pluginList;
};
mutable CachedVisiblePlugins m_cachedVisiblePlugins;
};
inline bool isSupportedPlugin(const Vector<SupportedPluginIdentifier>& pluginIdentifiers, const URL& pageURL, const String& pluginIdentifier)
{
return pluginIdentifiers.findIf([&] (auto&& plugin) {
return pageURL.isMatchingDomain(plugin.matchingDomain) && plugin.pluginIdentifier == pluginIdentifier;
}) != notFound;
}
template<class Decoder> inline std::optional<SupportedPluginIdentifier> SupportedPluginIdentifier::decode(Decoder& decoder)
{
std::optional<String> matchingDomain;
decoder >> matchingDomain;
if (!matchingDomain)
return std::nullopt;
std::optional<String> pluginIdentifier;
decoder >> pluginIdentifier;
if (!pluginIdentifier)
return std::nullopt;
return SupportedPluginIdentifier { WTFMove(matchingDomain.value()), WTFMove(pluginIdentifier.value()) };
}
template<class Encoder> inline void SupportedPluginIdentifier::encode(Encoder& encoder) const
{
encoder << matchingDomain;
encoder << pluginIdentifier;
}
} // namespace WebCore
namespace WTF {
template<> struct EnumTraits<WebCore::PluginLoadClientPolicy> {
using values = EnumValues<
WebCore::PluginLoadClientPolicy,
WebCore::PluginLoadClientPolicy::Undefined,
WebCore::PluginLoadClientPolicy::Block,
WebCore::PluginLoadClientPolicy::Ask,
WebCore::PluginLoadClientPolicy::Allow,
WebCore::PluginLoadClientPolicy::AllowAlways
>;
};
} // namespace WTF