2 * Copyright (C) 2006, 2007 Apple Inc. All rights reserved.
3 * Copyright (C) 2008 Collabora, Ltd. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
15 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE COMPUTER, INC. OR
18 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 #ifndef PluginPackage_h
28 #define PluginPackage_h
30 #include "FileSystem.h"
31 #include "PlatformString.h"
32 #include "PluginQuirkSet.h"
34 #include "npruntime_internal.h"
35 #include <wtf/HashMap.h>
36 #include <wtf/RefCounted.h>
37 #include <wtf/text/StringHash.h>
45 typedef HashMap<String, String> MIMEToDescriptionsMap;
46 typedef HashMap<String, Vector<String> > MIMEToExtensionsMap;
48 class PluginPackage : public RefCounted<PluginPackage> {
51 static PassRefPtr<PluginPackage> createPackage(const String& path, const time_t& lastModified);
52 #if ENABLE(NETSCAPE_PLUGIN_METADATA_CACHE)
53 static PassRefPtr<PluginPackage> createPackageFromCache(const String& path, const time_t& lastModified, const String& name, const String& description, const String& mimeDescription);
56 const String& name() const { return m_name; }
57 const String& description() const { return m_description; }
58 const String& path() const { return m_path; }
59 const String& fileName() const { return m_fileName; }
60 const String& parentDirectory() const { return m_parentDirectory; }
61 PlatformModule module() const { return m_module; }
62 uint16_t NPVersion() const;
63 time_t lastModified() const { return m_lastModified; }
65 const MIMEToDescriptionsMap& mimeToDescriptions() const { return m_mimeToDescriptions; }
66 const MIMEToExtensionsMap& mimeToExtensions() const { return m_mimeToExtensions; }
68 unsigned hash() const;
69 static bool equal(const PluginPackage& a, const PluginPackage& b);
73 void unloadWithoutShutdown();
75 bool isEnabled() const { return m_isEnabled; }
76 void setEnabled(bool);
78 const NPPluginFuncs* pluginFuncs() const { return &m_pluginFuncs; }
79 int compareFileVersion(const PlatformModuleVersion&) const;
80 int compare(const PluginPackage&) const;
81 PluginQuirkSet quirks() const { return m_quirks; }
82 const PlatformModuleVersion& version() const { return m_moduleVersion; }
84 NPInterface* npInterface() const { return m_npInterface; }
87 #if ENABLE(NETSCAPE_PLUGIN_METADATA_CACHE)
88 bool ensurePluginLoaded();
89 void setMIMEDescription(const String& mimeDescription);
90 String fullMIMEDescription() const { return m_fullMIMEDescription;}
93 PluginPackage(const String& path, const time_t& lastModified);
96 NPInterface* m_npInterface;
97 QPluginLoader* m_pluginLoader;
100 bool isPluginBlacklisted();
101 void determineQuirks(const String& mimeType);
103 void determineModuleVersionFromDescription();
104 void initializeBrowserFuncs();
110 String m_description;
114 String m_parentDirectory;
116 PlatformModuleVersion m_moduleVersion;
118 MIMEToDescriptionsMap m_mimeToDescriptions;
119 MIMEToExtensionsMap m_mimeToExtensions;
121 PlatformModule m_module;
122 time_t m_lastModified;
124 NPP_ShutdownProcPtr m_NPP_Shutdown;
125 NPPluginFuncs m_pluginFuncs;
126 NPNetscapeFuncs m_browserFuncs;
128 void freeLibrarySoon();
129 void freeLibraryTimerFired(Timer<PluginPackage>*);
130 Timer<PluginPackage> m_freeLibraryTimer;
132 PluginQuirkSet m_quirks;
133 #if ENABLE(NETSCAPE_PLUGIN_METADATA_CACHE)
134 String m_fullMIMEDescription;
135 bool m_infoIsFromCache;
139 struct PluginPackageHash {
140 static unsigned hash(const uintptr_t key) { return reinterpret_cast<PluginPackage*>(key)->hash(); }
141 static unsigned hash(const RefPtr<PluginPackage>& key) { return key->hash(); }
143 static bool equal(const uintptr_t a, const uintptr_t b) { return equal(reinterpret_cast<PluginPackage*>(a), reinterpret_cast<PluginPackage*>(b)); }
144 static bool equal(const RefPtr<PluginPackage>& a, const RefPtr<PluginPackage>& b) { return PluginPackage::equal(*a.get(), *b.get()); }
145 static const bool safeToCompareToEmptyOrDeleted = false;
148 } // namespace WebCore