2010-09-27 Andreas Kling <andreas.kling@nokia.com>
[webkit:qtwebkit.git] / WebCore / plugins / PluginPackage.cpp
1 /*
2  * Copyright (C) 2006, 2008 Apple Inc. All rights reserved.
3  * Copyright (C) 2008 Collabora Ltd.  All rights reserved.
4  * Copyright (C) 2009 Holger Hans Peter Freyther
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
16  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
19  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
22  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
23  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27
28 #include "config.h"
29 #include "PluginPackage.h"
30
31 #include "MIMETypeRegistry.h"
32 #include "PluginDatabase.h"
33 #include "PluginDebug.h"
34 #include "Timer.h"
35 #include "npruntime_impl.h"
36 #include <string.h>
37 #include <wtf/OwnArrayPtr.h>
38 #include <wtf/text/CString.h>
39
40 namespace WebCore {
41
42 PluginPackage::~PluginPackage()
43 {
44     // This destructor gets called during refresh() if PluginDatabase's
45     // PluginSet hash is already populated, as it removes items from
46     // the hash table. Calling the destructor on a loaded plug-in of
47     // course would cause a crash, so we check to call unload before we
48     // ASSERT.
49     // FIXME: There is probably a better way to fix this.
50     if (!m_loadCount)
51         unloadWithoutShutdown();
52     else
53         unload();
54
55     ASSERT(!m_isLoaded);
56 }
57
58 void PluginPackage::freeLibrarySoon()
59 {
60     ASSERT(!m_freeLibraryTimer.isActive());
61     ASSERT(m_module);
62     ASSERT(!m_loadCount);
63
64     m_freeLibraryTimer.startOneShot(0);
65 }
66
67 void PluginPackage::freeLibraryTimerFired(Timer<PluginPackage>*)
68 {
69     ASSERT(m_module);
70     ASSERT(!m_loadCount);
71
72     unloadModule(m_module);
73     m_module = 0;
74 }
75
76
77 int PluginPackage::compare(const PluginPackage& compareTo) const
78 {
79     // Sort plug-ins that allow multiple instances first.
80     bool AallowsMultipleInstances = !quirks().contains(PluginQuirkDontAllowMultipleInstances);
81     bool BallowsMultipleInstances = !compareTo.quirks().contains(PluginQuirkDontAllowMultipleInstances);
82     if (AallowsMultipleInstances != BallowsMultipleInstances)
83         return AallowsMultipleInstances ? -1 : 1;
84
85     // Sort plug-ins in a preferred path first.
86     bool AisInPreferredDirectory = PluginDatabase::isPreferredPluginDirectory(parentDirectory());
87     bool BisInPreferredDirectory = PluginDatabase::isPreferredPluginDirectory(compareTo.parentDirectory());
88     if (AisInPreferredDirectory != BisInPreferredDirectory)
89         return AisInPreferredDirectory ? -1 : 1;
90
91     int diff = strcmp(name().utf8().data(), compareTo.name().utf8().data());
92     if (diff)
93         return diff;
94
95     diff = compareFileVersion(compareTo.version());
96     if (diff)
97         return diff;
98
99     return strcmp(parentDirectory().utf8().data(), compareTo.parentDirectory().utf8().data());
100 }
101
102 PluginPackage::PluginPackage(const String& path, const time_t& lastModified)
103     : m_isEnabled(true)
104     , m_isLoaded(false)
105     , m_loadCount(0)
106     , m_path(path)
107     , m_moduleVersion(0)
108     , m_module(0)
109     , m_lastModified(lastModified)
110     , m_freeLibraryTimer(this, &PluginPackage::freeLibraryTimerFired)
111 #if ENABLE(NETSCAPE_PLUGIN_METADATA_CACHE)
112     , m_infoIsFromCache(true)
113 #endif
114 {
115     m_fileName = pathGetFileName(m_path);
116     m_parentDirectory = m_path.left(m_path.length() - m_fileName.length() - 1);
117 }
118
119 #if !OS(SYMBIAN)
120 void PluginPackage::unload()
121 {
122     if (!m_isLoaded)
123         return;
124
125     if (--m_loadCount > 0)
126         return;
127
128     m_NPP_Shutdown();
129
130     unloadWithoutShutdown();
131 }
132 #endif // !OS(SYMBIAN)
133
134 void PluginPackage::unloadWithoutShutdown()
135 {
136     if (!m_isLoaded)
137         return;
138
139     ASSERT(!m_loadCount);
140     ASSERT(m_module);
141
142     // <rdar://5530519>: Crash when closing tab with pdf file (Reader 7 only)
143     // If the plugin has subclassed its parent window, as with Reader 7, we may have
144     // gotten here by way of the plugin's internal window proc forwarding a message to our
145     // original window proc. If we free the plugin library from here, we will jump back
146     // to code we just freed when we return, so delay calling FreeLibrary at least until
147     // the next message loop
148     freeLibrarySoon();
149
150     m_isLoaded = false;
151 }
152
153 void PluginPackage::setEnabled(bool enabled)
154 {
155     m_isEnabled = enabled;
156 }
157
158 PassRefPtr<PluginPackage> PluginPackage::createPackage(const String& path, const time_t& lastModified)
159 {
160     RefPtr<PluginPackage> package = adoptRef(new PluginPackage(path, lastModified));
161
162     if (!package->fetchInfo())
163         return 0;
164
165     return package.release();
166 }
167
168 #if ENABLE(NETSCAPE_PLUGIN_METADATA_CACHE)
169 PassRefPtr<PluginPackage> PluginPackage::createPackageFromCache(const String& path, const time_t& lastModified, const String& name, const String& description, const String& mimeDescription)
170 {
171     RefPtr<PluginPackage> package = adoptRef(new PluginPackage(path, lastModified));
172     package->m_name = name;
173     package->m_description = description;
174     package->determineModuleVersionFromDescription();
175     package->setMIMEDescription(mimeDescription);
176     package->m_infoIsFromCache = true;
177     return package.release();
178 }
179 #endif
180
181 #if defined(XP_UNIX)
182 void PluginPackage::determineQuirks(const String& mimeType)
183 {
184     if (MIMETypeRegistry::isJavaAppletMIMEType(mimeType)) {
185         // Because a single process cannot create multiple VMs, and we cannot reliably unload a
186         // Java VM, we cannot unload the Java plugin, or we'll lose reference to our only VM
187         m_quirks.add(PluginQuirkDontUnloadPlugin);
188
189         // Setting the window region to an empty region causes bad scrolling repaint problems
190         // with the Java plug-in.
191         m_quirks.add(PluginQuirkDontClipToZeroRectWhenScrolling);
192         return;
193     }
194
195     if (mimeType == "application/x-shockwave-flash") {
196         static const PlatformModuleVersion flashTenVersion(0x0a000000);
197
198         if (compareFileVersion(flashTenVersion) >= 0) {
199             // Flash 10.0 b218 doesn't like having a NULL window handle
200             m_quirks.add(PluginQuirkDontSetNullWindowHandleOnDestroy);
201 #if PLATFORM(QT)
202             m_quirks.add(PluginQuirkRequiresGtkToolKit);
203 #endif
204         } else {
205             // Flash 9 and older requests windowless plugins if we return a mozilla user agent
206             m_quirks.add(PluginQuirkWantsMozillaUserAgent);
207         }
208
209 #if PLATFORM(QT) && CPU(X86)
210         // 32-bit Flash will crash on repeated calls to SetWindow in windowed mode
211         m_quirks.add(PluginQuirkDontCallSetWindowMoreThanOnce);
212 #endif
213
214         m_quirks.add(PluginQuirkRequiresDefaultScreenDepth);
215         m_quirks.add(PluginQuirkThrottleInvalidate);
216         m_quirks.add(PluginQuirkThrottleWMUserPlusOneMessages);
217         m_quirks.add(PluginQuirkFlashURLNotifyBug);
218     }
219
220 #if defined(Q_WS_MAEMO_5) || defined(Q_WS_MAEMO_6)
221     // Passing a 32-bit depth pixmap to NPAPI plugins is too inefficient. Instead, pass a X Pixmap
222     // that has same depth as the screen depth since graphics operations are optimized
223     // for this depth.
224     m_quirks.add(PluginQuirkRequiresDefaultScreenDepth);
225 #endif
226 }
227 #endif
228
229 #if !OS(WINDOWS)
230 void PluginPackage::determineModuleVersionFromDescription()
231 {
232     // It's a bit lame to detect the plugin version by parsing it
233     // from the plugin description string, but it doesn't seem that
234     // version information is available in any standardized way at
235     // the module level, like in Windows
236
237     if (m_description.isEmpty())
238         return;
239
240     if (m_description.startsWith("Shockwave Flash") && m_description.length() >= 19) {
241         // The flash version as a PlatformModuleVersion differs on Unix from Windows
242         // since the revision can be larger than a 8 bits, so we allow it 16 here and
243         // push the major/minor up 8 bits. Thus on Unix, Flash's version may be
244         // 0x0a000000 instead of 0x000a0000.
245
246         Vector<String> versionParts;
247         m_description.substring(16).split(' ', /*allowEmptyEntries =*/ false, versionParts);
248         if (versionParts.isEmpty())
249             return;
250
251         if (versionParts.size() >= 1) {
252             Vector<String> majorMinorParts;
253             versionParts[0].split('.', majorMinorParts);
254             if (majorMinorParts.size() >= 1) {
255                 bool converted = false;
256                 unsigned major = majorMinorParts[0].toUInt(&converted);
257                 if (converted)
258                     m_moduleVersion = (major & 0xff) << 24;
259             }
260             if (majorMinorParts.size() == 2) {
261                 bool converted = false;
262                 unsigned minor = majorMinorParts[1].toUInt(&converted);
263                 if (converted)
264                     m_moduleVersion |= (minor & 0xff) << 16;
265             }
266         }
267
268         if (versionParts.size() >= 2) {
269             String revision = versionParts[1];
270             if (revision.length() > 1 && (revision[0] == 'r' || revision[0] == 'b')) {
271                 revision.remove(0, 1);
272                 m_moduleVersion |= revision.toInt() & 0xffff;
273             }
274         }
275     }
276 }
277 #endif
278
279 #if ENABLE(NETSCAPE_PLUGIN_API)
280 void PluginPackage::initializeBrowserFuncs()
281 {
282     memset(&m_browserFuncs, 0, sizeof(m_browserFuncs));
283     m_browserFuncs.size = sizeof(m_browserFuncs);
284     m_browserFuncs.version = NPVersion();
285
286     m_browserFuncs.geturl = NPN_GetURL;
287     m_browserFuncs.posturl = NPN_PostURL;
288     m_browserFuncs.requestread = NPN_RequestRead;
289     m_browserFuncs.newstream = NPN_NewStream;
290     m_browserFuncs.write = NPN_Write;
291     m_browserFuncs.destroystream = NPN_DestroyStream;
292     m_browserFuncs.status = NPN_Status;
293     m_browserFuncs.uagent = NPN_UserAgent;
294     m_browserFuncs.memalloc = NPN_MemAlloc;
295     m_browserFuncs.memfree = NPN_MemFree;
296     m_browserFuncs.memflush = NPN_MemFlush;
297     m_browserFuncs.reloadplugins = NPN_ReloadPlugins;
298     m_browserFuncs.geturlnotify = NPN_GetURLNotify;
299     m_browserFuncs.posturlnotify = NPN_PostURLNotify;
300     m_browserFuncs.getvalue = NPN_GetValue;
301     m_browserFuncs.setvalue = NPN_SetValue;
302     m_browserFuncs.invalidaterect = NPN_InvalidateRect;
303     m_browserFuncs.invalidateregion = NPN_InvalidateRegion;
304     m_browserFuncs.forceredraw = NPN_ForceRedraw;
305     m_browserFuncs.getJavaEnv = NPN_GetJavaEnv;
306     m_browserFuncs.getJavaPeer = NPN_GetJavaPeer;
307     m_browserFuncs.pushpopupsenabledstate = NPN_PushPopupsEnabledState;
308     m_browserFuncs.poppopupsenabledstate = NPN_PopPopupsEnabledState;
309     m_browserFuncs.pluginthreadasynccall = NPN_PluginThreadAsyncCall;
310
311     m_browserFuncs.releasevariantvalue = _NPN_ReleaseVariantValue;
312     m_browserFuncs.getstringidentifier = _NPN_GetStringIdentifier;
313     m_browserFuncs.getstringidentifiers = _NPN_GetStringIdentifiers;
314     m_browserFuncs.getintidentifier = _NPN_GetIntIdentifier;
315     m_browserFuncs.identifierisstring = _NPN_IdentifierIsString;
316     m_browserFuncs.utf8fromidentifier = _NPN_UTF8FromIdentifier;
317     m_browserFuncs.intfromidentifier = _NPN_IntFromIdentifier;
318     m_browserFuncs.createobject = _NPN_CreateObject;
319     m_browserFuncs.retainobject = _NPN_RetainObject;
320     m_browserFuncs.releaseobject = _NPN_ReleaseObject;
321     m_browserFuncs.invoke = _NPN_Invoke;
322     m_browserFuncs.invokeDefault = _NPN_InvokeDefault;
323     m_browserFuncs.evaluate = _NPN_Evaluate;
324     m_browserFuncs.getproperty = _NPN_GetProperty;
325     m_browserFuncs.setproperty = _NPN_SetProperty;
326     m_browserFuncs.removeproperty = _NPN_RemoveProperty;
327     m_browserFuncs.hasproperty = _NPN_HasProperty;
328     m_browserFuncs.hasmethod = _NPN_HasMethod;
329     m_browserFuncs.setexception = _NPN_SetException;
330     m_browserFuncs.enumerate = _NPN_Enumerate;
331     m_browserFuncs.construct = _NPN_Construct;
332 }
333 #endif
334
335 #if ENABLE(PLUGIN_PACKAGE_SIMPLE_HASH)
336 unsigned PluginPackage::hash() const
337 {
338     unsigned hashCodes[] = {
339         m_path.impl()->hash(),
340         m_lastModified
341     };
342
343     return StringImpl::computeHash(reinterpret_cast<UChar*>(hashCodes), sizeof(hashCodes) / sizeof(UChar));
344 }
345
346 bool PluginPackage::equal(const PluginPackage& a, const PluginPackage& b)
347 {
348     return a.m_description == b.m_description;
349 }
350 #endif
351
352 int PluginPackage::compareFileVersion(const PlatformModuleVersion& compareVersion) const
353 {
354     // return -1, 0, or 1 if plug-in version is less than, equal to, or greater than
355     // the passed version
356
357 #if OS(WINDOWS)
358     if (m_moduleVersion.mostSig != compareVersion.mostSig)
359         return m_moduleVersion.mostSig > compareVersion.mostSig ? 1 : -1;
360     if (m_moduleVersion.leastSig != compareVersion.leastSig)
361         return m_moduleVersion.leastSig > compareVersion.leastSig ? 1 : -1;
362 #else    
363     if (m_moduleVersion != compareVersion)
364         return m_moduleVersion > compareVersion ? 1 : -1;
365 #endif
366
367     return 0;
368 }
369
370 #if ENABLE(NETSCAPE_PLUGIN_METADATA_CACHE)
371 bool PluginPackage::ensurePluginLoaded()
372 {
373     if (!m_infoIsFromCache)
374         return m_isLoaded;
375
376     m_quirks = PluginQuirkSet();
377     m_name = String();
378     m_description = String();
379     m_fullMIMEDescription = String();
380     m_moduleVersion = 0;
381
382     return fetchInfo();
383 }
384 #endif
385
386 }