1/*
2 * Copyright (C) 2010 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#ifndef NetscapePluginModule_h
27#define NetscapePluginModule_h
28
29#include "Module.h"
30#include "PluginQuirks.h"
31#include <WebCore/npruntime_internal.h>
32#include <wtf/RefCounted.h>
33#include <wtf/text/WTFString.h>
34
35// FIXME: We should not include PluginInfoStore.h here. Instead,
36// PluginInfoStore::Plugin should be moved out into its own header which we can
37// put in Shared/Plugins.
38#include "PluginInfoStore.h"
39
40namespace WebKit {
41
42class NetscapePluginModule : public RefCounted<NetscapePluginModule> {
43public:
44    static PassRefPtr<NetscapePluginModule> getOrCreate(const String& pluginPath);
45    ~NetscapePluginModule();
46
47    const NPPluginFuncs& pluginFuncs() const { return m_pluginFuncs; }
48
49    void incrementLoadCount();
50    void decrementLoadCount();
51
52    static bool getPluginInfo(const String& pluginPath, PluginInfoStore::Plugin&);
53
54    const PluginQuirks& pluginQuirks() const { return m_pluginQuirks; }
55
56    // Return a list of domains for which the plug-in has data stored.
57    Vector<String> sitesWithData();
58
59    // Request that the plug-in clear the site data.
60    bool clearSiteData(const String& site, uint64_t flags, uint64_t maxAge);
61
62private:
63    explicit NetscapePluginModule(const String& pluginPath);
64
65    void determineQuirks();
66
67#if PLUGIN_ARCHITECTURE(X11)
68    void applyX11QuirksBeforeLoad();
69#endif
70
71    bool tryGetSitesWithData(Vector<String>&);
72    bool tryClearSiteData(const String& site, uint64_t flags, uint64_t maxAge);
73
74    bool tryLoad();
75    bool load();
76    void unload();
77
78    void shutdown();
79
80    String m_pluginPath;
81    bool m_isInitialized;
82    unsigned m_loadCount;
83
84    PluginQuirks m_pluginQuirks;
85
86    NPP_ShutdownProcPtr m_shutdownProcPtr;
87    NPPluginFuncs m_pluginFuncs;
88
89    OwnPtr<Module> m_module;
90};
91
92} // namespace WebKit
93
94#endif // NetscapePluginModule_h
95