blob: b4883dea9976db50cde52860aa9b92b5bb1010df [file] [log] [blame]
/*
* Copyright (C) 2006, 2007 Apple Inc. All rights reserved.
* Copyright (C) 2008 Collabora, Ltd. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef PluginPackage_h
#define PluginPackage_h
#include "PlatformModule.h"
#include "PluginQuirkSet.h"
#include <WebCore/FileSystem.h>
#include <WebCore/Timer.h>
#include <wtf/HashMap.h>
#include <wtf/RefCounted.h>
#include <wtf/text/StringHash.h>
#include <wtf/text/WTFString.h>
#if ENABLE(NETSCAPE_PLUGIN_API)
#include <WebCore/npruntime_internal.h>
#endif
namespace WebCore {
typedef HashMap<String, String, ASCIICaseInsensitiveHash> MIMEToDescriptionsMap;
typedef HashMap<String, Vector<String>, ASCIICaseInsensitiveHash> MIMEToExtensionsMap;
class PluginPackage : public RefCounted<PluginPackage> {
public:
~PluginPackage();
static RefPtr<PluginPackage> createPackage(const String& path, const time_t& lastModified);
#if ENABLE(NETSCAPE_PLUGIN_METADATA_CACHE)
static Ref<PluginPackage> createPackageFromCache(const String& path, const time_t& lastModified, const String& name, const String& description, const String& mimeDescription);
#endif
const String& name() const { return m_name; }
const String& description() const { return m_description; }
const String& path() const { return m_path; }
const String& fileName() const { return m_fileName; }
const String& parentDirectory() const { return m_parentDirectory; }
PlatformModule module() const { return m_module; }
uint16_t NPVersion() const;
time_t lastModified() const { return m_lastModified; }
const MIMEToDescriptionsMap& mimeToDescriptions() const { return m_mimeToDescriptions; }
const MIMEToExtensionsMap& mimeToExtensions() const { return m_mimeToExtensions; }
unsigned hash() const;
static bool equal(const PluginPackage& a, const PluginPackage& b);
bool load();
void unload();
void unloadWithoutShutdown();
bool isEnabled() const { return m_isEnabled; }
void setEnabled(bool);
#if ENABLE(NETSCAPE_PLUGIN_API)
const NPPluginFuncs* pluginFuncs() const { return &m_pluginFuncs; }
#endif
int compareFileVersion(const PlatformModuleVersion&) const;
int compare(const PluginPackage&) const;
PluginQuirkSet quirks() const { return m_quirks; }
const PlatformModuleVersion& version() const { return m_moduleVersion; }
#if ENABLE(NETSCAPE_PLUGIN_METADATA_CACHE)
bool ensurePluginLoaded();
void setMIMEDescription(const String& mimeDescription);
String fullMIMEDescription() const { return m_fullMIMEDescription;}
#endif
private:
PluginPackage(const String& path, const time_t& lastModified);
bool fetchInfo();
bool isPluginBlacklisted();
void determineQuirks(const String& mimeType);
void determineModuleVersionFromDescription();
void initializeBrowserFuncs();
bool m_isEnabled;
bool m_isLoaded;
int m_loadCount;
String m_description;
String m_path;
String m_fileName;
String m_name;
String m_parentDirectory;
PlatformModuleVersion m_moduleVersion;
MIMEToDescriptionsMap m_mimeToDescriptions;
MIMEToExtensionsMap m_mimeToExtensions;
PlatformModule m_module;
time_t m_lastModified;
#if ENABLE(NETSCAPE_PLUGIN_API)
NPP_ShutdownProcPtr m_NPP_Shutdown;
NPPluginFuncs m_pluginFuncs;
NPNetscapeFuncs m_browserFuncs;
#endif
void freeLibrarySoon();
void freeLibraryTimerFired();
Timer m_freeLibraryTimer;
PluginQuirkSet m_quirks;
#if ENABLE(NETSCAPE_PLUGIN_METADATA_CACHE)
String m_fullMIMEDescription;
bool m_infoIsFromCache;
#endif
};
// FIXME: This is a workaround because PluginPackageHash is broken and may consider keys with different hashes as equal.
struct PluginPackageHashTraits : HashTraits<RefPtr<PluginPackage> > {
static const int minimumTableSize = 64;
};
struct PluginPackageHash {
static unsigned hash(const uintptr_t key) { return reinterpret_cast<PluginPackage*>(key)->hash(); }
static unsigned hash(const RefPtr<PluginPackage>& key) { return key->hash(); }
static bool equal(const uintptr_t a, const uintptr_t b) { return equal(reinterpret_cast<PluginPackage*>(a), reinterpret_cast<PluginPackage*>(b)); }
static bool equal(const RefPtr<PluginPackage>& a, const RefPtr<PluginPackage>& b) { return PluginPackage::equal(*a.get(), *b.get()); }
static const bool safeToCompareToEmptyOrDeleted = false;
};
} // namespace WebCore
#endif