2008-05-14 Julien Chaffraix <jchaffraix@webkit.org>
[WebKit-https.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  *
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 #include "config.h"
28 #include "PluginPackage.h"
29
30 #include "CString.h"
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
39 namespace WebCore {
40
41 PluginPackage::~PluginPackage()
42 {
43     // This destructor gets called during refresh() if PluginDatabase's
44     // PluginSet hash is already populated, as it removes items from
45     // the hash table. Calling the destructor on a loaded plug-in of
46     // course would cause a crash, so we check to call unload before we
47     // ASSERT.
48     // FIXME: There is probably a better way to fix this.
49     if (m_loadCount == 0)
50         unloadWithoutShutdown();
51     else
52         unload();
53
54     ASSERT(!m_isLoaded);
55 }
56
57 void PluginPackage::freeLibrarySoon()
58 {
59     ASSERT(!m_freeLibraryTimer.isActive());
60     ASSERT(m_module);
61     ASSERT(m_loadCount == 0);
62
63     m_freeLibraryTimer.startOneShot(0);
64 }
65
66 void PluginPackage::freeLibraryTimerFired(Timer<PluginPackage>*)
67 {
68     ASSERT(m_module);
69     ASSERT(m_loadCount == 0);
70
71     unloadModule(m_module);
72     m_module = 0;
73 }
74
75
76 int PluginPackage::compare(const PluginPackage& compareTo) const
77 {
78     // Sort plug-ins that allow multiple instances first.
79     bool AallowsMultipleInstances = !quirks().contains(PluginQuirkDontAllowMultipleInstances);
80     bool BallowsMultipleInstances = !compareTo.quirks().contains(PluginQuirkDontAllowMultipleInstances);
81     if (AallowsMultipleInstances != BallowsMultipleInstances)
82         return AallowsMultipleInstances ? -1 : 1;
83
84     // Sort plug-ins in a preferred path first.
85     bool AisInPreferredDirectory = PluginDatabase::isPreferredPluginDirectory(parentDirectory());
86     bool BisInPreferredDirectory = PluginDatabase::isPreferredPluginDirectory(compareTo.parentDirectory());
87     if (AisInPreferredDirectory != BisInPreferredDirectory)
88         return AisInPreferredDirectory ? -1 : 1;
89
90     int diff = strcmp(name().utf8().data(), compareTo.name().utf8().data());
91     if (diff)
92         return diff;
93
94     if (diff = compareFileVersion(compareTo.version()))
95         return diff;
96
97     return strcmp(parentDirectory().utf8().data(), compareTo.parentDirectory().utf8().data());
98 }
99
100 PluginPackage::PluginPackage(const String& path, const time_t& lastModified)
101     : m_isLoaded(false)
102     , m_loadCount(0)
103     , m_path(path)
104     , m_moduleVersion(0)
105     , m_module(0)
106     , m_lastModified(lastModified)
107     , m_freeLibraryTimer(this, &PluginPackage::freeLibraryTimerFired)
108 {
109     m_fileName = pathGetFileName(m_path);
110     m_parentDirectory = m_path.left(m_path.length() - m_fileName.length() - 1);
111 }
112
113 void PluginPackage::unload()
114 {
115     if (!m_isLoaded)
116         return;
117
118     if (--m_loadCount > 0)
119         return;
120
121     m_NPP_Shutdown();
122
123     unloadWithoutShutdown();
124 }
125
126 void PluginPackage::unloadWithoutShutdown()
127 {
128     if (!m_isLoaded)
129         return;
130
131     ASSERT(m_loadCount == 0);
132     ASSERT(m_module);
133
134     // <rdar://5530519>: Crash when closing tab with pdf file (Reader 7 only)
135     // If the plugin has subclassed its parent window, as with Reader 7, we may have
136     // gotten here by way of the plugin's internal window proc forwarding a message to our
137     // original window proc. If we free the plugin library from here, we will jump back
138     // to code we just freed when we return, so delay calling FreeLibrary at least until
139     // the next message loop
140     freeLibrarySoon();
141
142     m_isLoaded = false;
143 }
144
145 PassRefPtr<PluginPackage> PluginPackage::createPackage(const String& path, const time_t& lastModified)
146 {
147     RefPtr<PluginPackage> package = adoptRef(new PluginPackage(path, lastModified));
148
149     if (!package->fetchInfo())
150         return 0;
151     
152     return package.release();
153 }
154
155 }