PluginPackage.h revision 0bf48ef3be53ddaa52bbead65dfd75bf90e7a2b5 
1/*
2 * Copyright (C) 2006, 2007 Apple Inc.  All rights reserved.
3 * Copyright (C) 2008 Collabora, Ltd.  All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
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.
13 *
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.
25 */
26
27#ifndef PluginPackage_H
28#define PluginPackage_H
29
30#include "FileSystem.h"
31#include "PlatformString.h"
32#include "PluginQuirkSet.h"
33#include "StringHash.h"
34#include "Timer.h"
35#include "npruntime_internal.h"
36#include <wtf/HashMap.h>
37#include <wtf/RefCounted.h>
38#if defined(ANDROID_PLUGINS)
39#include <nativehelper/jni.h>
40#endif
41
42namespace WebCore {
43    typedef HashMap<String, String> MIMEToDescriptionsMap;
44    typedef HashMap<String, Vector<String> > MIMEToExtensionsMap;
45
46    class PluginPackage : public RefCounted<PluginPackage> {
47    public:
48        ~PluginPackage();
49        static PassRefPtr<PluginPackage> createPackage(const String& path, const time_t& lastModified);
50
51        const String& name() const { return m_name; }
52        const String& description() const { return m_description; }
53        const String& path() const { return m_path; }
54        const String& fileName() const { return m_fileName; }
55        const String& parentDirectory() const { return m_parentDirectory; }
56        time_t lastModified() const { return m_lastModified; }
57
58        const MIMEToDescriptionsMap& mimeToDescriptions() const { return m_mimeToDescriptions; }
59        const MIMEToExtensionsMap& mimeToExtensions() const { return m_mimeToExtensions; }
60
61        unsigned hash() const;
62        static bool equal(const PluginPackage& a, const PluginPackage& b);
63
64        bool load();
65        void unload();
66        void unloadWithoutShutdown();
67
68        bool isEnabled() const { return m_isEnabled; }
69        void setEnabled(bool);
70
71        const NPPluginFuncs* pluginFuncs() const { return &m_pluginFuncs; }
72        int compareFileVersion(const PlatformModuleVersion&) const;
73        int compare(const PluginPackage&) const;
74        PluginQuirkSet quirks() const { return m_quirks; }
75        const PlatformModuleVersion& version() const { return m_moduleVersion; }
76
77    private:
78        PluginPackage(const String& path, const time_t& lastModified);
79        bool fetchInfo();
80        bool isPluginBlacklisted();
81        void determineQuirks(const String& mimeType);
82
83        void determineModuleVersionFromDescription();
84        void initializeBrowserFuncs();
85
86        bool m_isEnabled;
87        bool m_isLoaded;
88        int m_loadCount;
89
90        String m_description;
91        String m_path;
92        String m_fileName;
93        String m_name;
94        String m_parentDirectory;
95
96        PlatformModuleVersion m_moduleVersion;
97
98        MIMEToDescriptionsMap m_mimeToDescriptions;
99        MIMEToExtensionsMap m_mimeToExtensions;
100
101        PlatformModule m_module;
102        time_t m_lastModified;
103
104        NPP_ShutdownProcPtr m_NPP_Shutdown;
105        NPPluginFuncs m_pluginFuncs;
106        NPNetscapeFuncs m_browserFuncs;
107
108        void freeLibrarySoon();
109        void freeLibraryTimerFired(Timer<PluginPackage>*);
110        Timer<PluginPackage> m_freeLibraryTimer;
111
112        PluginQuirkSet m_quirks;
113
114#if defined(ANDROID_PLUGINS)
115        // Java Plugin object.
116        jobject m_pluginObject;
117        // Called from unloadWithoutShutdown() to remove the object
118        // from the PluginList.
119        void unregisterPluginObject();
120#endif
121    };
122
123    struct PluginPackageHash {
124        static unsigned hash(const uintptr_t key) { return reinterpret_cast<PluginPackage*>(key)->hash(); }
125        static unsigned hash(const RefPtr<PluginPackage>& key) { return key->hash(); }
126
127        static bool equal(const uintptr_t a, const uintptr_t b) { return equal(reinterpret_cast<PluginPackage*>(a), reinterpret_cast<PluginPackage*>(b)); }
128        static bool equal(const RefPtr<PluginPackage>& a, const RefPtr<PluginPackage>& b) { return PluginPackage::equal(*a.get(), *b.get()); }
129        static const bool safeToCompareToEmptyOrDeleted = false;
130    };
131
132} // namespace WebCore
133
134#endif
135