NetscapePluginHostManager.mm [plain text]
/*
* Copyright (C) 2008 Apple Inc. All Rights Reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#if USE(PLUGIN_HOST_PROCESS)
#import "NetscapePluginHostManager.h"
#import "NetscapePluginHostProxy.h"
#import "NetscapePluginInstanceProxy.h"
#import "WebLocalizableStrings.h"
#import "WebKitSystemInterface.h"
#import "WebHostedNetscapePluginView.h"
#import "WebNetscapePluginPackage.h"
#import "WebPreferencesPrivate.h"
#import "WebView.h"
#import <mach/mach_port.h>
#import <servers/bootstrap.h>
#import <spawn.h>
#import <wtf/Assertions.h>
#import <wtf/RetainPtr.h>
#import <wtf/StdLibExtras.h>
extern "C" {
#import "WebKitPluginAgent.h"
#import "WebKitPluginHost.h"
}
using namespace std;
namespace WebKit {
NetscapePluginHostManager& NetscapePluginHostManager::shared()
{
DEFINE_STATIC_LOCAL(NetscapePluginHostManager, pluginHostManager, ());
return pluginHostManager;
}
static const NSString *pluginHostAppName = @"WebKitPluginHost.app";
NetscapePluginHostManager::NetscapePluginHostManager()
: m_pluginVendorPort(MACH_PORT_NULL)
{
}
NetscapePluginHostManager::~NetscapePluginHostManager()
{
}
NetscapePluginHostProxy* NetscapePluginHostManager::hostForPackage(WebNetscapePluginPackage *package, bool useProxiedOpenPanel)
{
pair<PluginHostMap::iterator, bool> result = m_pluginHosts.add(package, 0);
// The package was already in the map, just return it.
if (!result.second)
return result.first->second;
mach_port_t clientPort;
if (mach_port_allocate(mach_task_self(), MACH_PORT_RIGHT_RECEIVE, &clientPort) != KERN_SUCCESS) {
m_pluginHosts.remove(result.first);
return 0;
}
mach_port_t pluginHostPort;
ProcessSerialNumber pluginHostPSN;
if (!spawnPluginHost(package, clientPort, pluginHostPort, pluginHostPSN, useProxiedOpenPanel)) {
mach_port_destroy(mach_task_self(), clientPort);
m_pluginHosts.remove(result.first);
return 0;
}
// Since Flash NPObjects add methods dynamically, we don't want to cache when a property/method doesn't exist
// on an object because it could be added later.
bool shouldCacheMissingPropertiesAndMethods = ![[[package bundle] bundleIdentifier] isEqualToString:@"com.macromedia.Flash Player.plugin"];
NetscapePluginHostProxy* hostProxy = new NetscapePluginHostProxy(clientPort, pluginHostPort, pluginHostPSN, shouldCacheMissingPropertiesAndMethods);
CFRetain(package);
result.first->second = hostProxy;
return hostProxy;
}
bool NetscapePluginHostManager::spawnPluginHost(WebNetscapePluginPackage *package, mach_port_t clientPort, mach_port_t& pluginHostPort, ProcessSerialNumber& pluginHostPSN, bool useProxiedOpenPanel)
{
if (m_pluginVendorPort == MACH_PORT_NULL) {
if (!initializeVendorPort())
return false;
}
mach_port_t renderServerPort = WKInitializeRenderServer();
if (renderServerPort == MACH_PORT_NULL)
return false;
NSString *pluginHostAppPath = [[NSBundle bundleWithIdentifier:@"com.apple.WebKit"] pathForAuxiliaryExecutable:pluginHostAppName];
NSString *pluginHostAppExecutablePath = [[NSBundle bundleWithPath:pluginHostAppPath] executablePath];
RetainPtr<CFStringRef> localization(AdoptCF, WKCopyCFLocalizationPreferredName(NULL));
NSDictionary *launchProperties = [[NSDictionary alloc] initWithObjectsAndKeys:
pluginHostAppExecutablePath, @"pluginHostPath",
[NSNumber numberWithInt:[package pluginHostArchitecture]], @"cpuType",
localization.get(), @"localization",
[NSNumber numberWithBool:useProxiedOpenPanel], @"useProxiedOpenPanel",
nil];
NSData *data = [NSPropertyListSerialization dataFromPropertyList:launchProperties format:NSPropertyListBinaryFormat_v1_0 errorDescription:0];
ASSERT(data);
[launchProperties release];
kern_return_t kr = _WKPASpawnPluginHost(m_pluginVendorPort, reinterpret_cast<uint8_t*>(const_cast<void*>([data bytes])), [data length], &pluginHostPort);
if (kr == MACH_SEND_INVALID_DEST) {
// The plug-in vendor port has gone away for some reason. Try to reinitialize it.
m_pluginVendorPort = MACH_PORT_NULL;
if (!initializeVendorPort())
return false;
// And spawn the plug-in host again.
kr = _WKPASpawnPluginHost(m_pluginVendorPort, reinterpret_cast<uint8_t*>(const_cast<void*>([data bytes])), [data length], &pluginHostPort);
}
if (kr != KERN_SUCCESS) {
// FIXME: Check for invalid dest and try to re-spawn the plug-in agent.
LOG_ERROR("Failed to spawn plug-in host, error %x", kr);
return false;
}
NSString *visibleName = [NSString stringWithFormat:UI_STRING("%@ (%@ Internet plug-in)",
"visible name of the plug-in host process. The first argument is the plug-in name "
"and the second argument is the application name."),
[[package filename] stringByDeletingPathExtension], [[NSProcessInfo processInfo] processName]];
NSDictionary *hostProperties = [[NSDictionary alloc] initWithObjectsAndKeys:
visibleName, @"visibleName",
[package path], @"bundlePath",
nil];
data = [NSPropertyListSerialization dataFromPropertyList:hostProperties format:NSPropertyListBinaryFormat_v1_0 errorDescription:nil];
ASSERT(data);
[hostProperties release];
ProcessSerialNumber psn;
GetCurrentProcess(&psn);
kr = _WKPHCheckInWithPluginHost(pluginHostPort, (uint8_t*)[data bytes], [data length], clientPort, psn.highLongOfPSN, psn.lowLongOfPSN, renderServerPort,
&pluginHostPSN.highLongOfPSN, &pluginHostPSN.lowLongOfPSN);
if (kr != KERN_SUCCESS) {
mach_port_deallocate(mach_task_self(), pluginHostPort);
LOG_ERROR("Failed to check in with plug-in host, error %x", kr);
return false;
}
return true;
}
bool NetscapePluginHostManager::initializeVendorPort()
{
ASSERT(m_pluginVendorPort == MACH_PORT_NULL);
// Get the plug-in agent port.
mach_port_t pluginAgentPort;
if (bootstrap_look_up(bootstrap_port, "com.apple.WebKit.PluginAgent", &pluginAgentPort) != KERN_SUCCESS) {
LOG_ERROR("Failed to look up the plug-in agent port");
return false;
}
NSData *appNameData = [[[NSProcessInfo processInfo] processName] dataUsingEncoding:NSUTF8StringEncoding];
// Tell the plug-in agent that we exist.
if (_WKPACheckInApplication(pluginAgentPort, (uint8_t*)[appNameData bytes], [appNameData length], &m_pluginVendorPort) != KERN_SUCCESS)
return false;
// FIXME: Should we add a notification for when the vendor port dies?
return true;
}
void NetscapePluginHostManager::pluginHostDied(NetscapePluginHostProxy* pluginHost)
{
PluginHostMap::iterator end = m_pluginHosts.end();
// This has O(n) complexity but the number of active plug-in hosts is very small so it shouldn't matter.
for (PluginHostMap::iterator it = m_pluginHosts.begin(); it != end; ++it) {
if (it->second == pluginHost) {
m_pluginHosts.remove(it);
return;
}
}
}
PassRefPtr<NetscapePluginInstanceProxy> NetscapePluginHostManager::instantiatePlugin(WebNetscapePluginPackage *pluginPackage, WebHostedNetscapePluginView *pluginView, NSString *mimeType, NSArray *attributeKeys, NSArray *attributeValues, NSString *userAgent, NSURL *sourceURL, bool fullFrame, bool isPrivateBrowsingEnabled, bool isAcceleratedCompositingEnabled)
{
WebPreferences *preferences = [[pluginView webView] preferences];
NetscapePluginHostProxy* hostProxy = hostForPackage(pluginPackage, [preferences usesProxiedOpenPanel]);
if (!hostProxy)
return 0;
RetainPtr<NSMutableDictionary> properties(AdoptNS, [[NSMutableDictionary alloc] init]);
if (mimeType)
[properties.get() setObject:mimeType forKey:@"mimeType"];
ASSERT_ARG(userAgent, userAgent);
[properties.get() setObject:userAgent forKey:@"userAgent"];
ASSERT_ARG(attributeKeys, attributeKeys);
[properties.get() setObject:attributeKeys forKey:@"attributeKeys"];
ASSERT_ARG(attributeValues, attributeValues);
[properties.get() setObject:attributeValues forKey:@"attributeValues"];
if (sourceURL)
[properties.get() setObject:[sourceURL absoluteString] forKey:@"sourceURL"];
[properties.get() setObject:[NSNumber numberWithBool:fullFrame] forKey:@"fullFrame"];
[properties.get() setObject:[NSNumber numberWithBool:isPrivateBrowsingEnabled] forKey:@"privateBrowsingEnabled"];
[properties.get() setObject:[NSNumber numberWithBool:isAcceleratedCompositingEnabled] forKey:@"acceleratedCompositingEnabled"];
NSData *data = [NSPropertyListSerialization dataFromPropertyList:properties.get() format:NSPropertyListBinaryFormat_v1_0 errorDescription:nil];
ASSERT(data);
RefPtr<NetscapePluginInstanceProxy> instance = NetscapePluginInstanceProxy::create(hostProxy, pluginView, fullFrame);
uint32_t requestID = instance->nextRequestID();
kern_return_t kr = _WKPHInstantiatePlugin(hostProxy->port(), requestID, (uint8_t*)[data bytes], [data length], instance->pluginID());
if (kr == MACH_SEND_INVALID_DEST) {
// Invalidate the instance.
instance->invalidate();
// The plug-in host must have died, but we haven't received the death notification yet.
pluginHostDied(hostProxy);
// Try to spawn it again.
hostProxy = hostForPackage(pluginPackage, [preferences usesProxiedOpenPanel]);
// Create a new instance.
instance = NetscapePluginInstanceProxy::create(hostProxy, pluginView, fullFrame);
requestID = instance->nextRequestID();
kr = _WKPHInstantiatePlugin(hostProxy->port(), requestID, (uint8_t*)[data bytes], [data length], instance->pluginID());
}
auto_ptr<NetscapePluginInstanceProxy::InstantiatePluginReply> reply = instance->waitForReply<NetscapePluginInstanceProxy::InstantiatePluginReply>(requestID);
if (!reply.get() || reply->m_resultCode != KERN_SUCCESS) {
instance->cleanup();
return 0;
}
instance->setRenderContextID(reply->m_renderContextID);
instance->setRendererType(reply->m_rendererType);
return instance.release();
}
void NetscapePluginHostManager::createPropertyListFile(WebNetscapePluginPackage *package)
{
NSString *pluginHostAppPath = [[NSBundle bundleWithIdentifier:@"com.apple.WebKit"] pathForAuxiliaryExecutable:pluginHostAppName];
NSString *pluginHostAppExecutablePath = [[NSBundle bundleWithPath:pluginHostAppPath] executablePath];
NSString *bundlePath = [package path];
pid_t pid;
posix_spawnattr_t attr;
posix_spawnattr_init(&attr);
// Set the architecture.
size_t ocount = 0;
int cpuTypes[1] = { [package pluginHostArchitecture] };
posix_spawnattr_setbinpref_np(&attr, 1, cpuTypes, &ocount);
// Spawn the plug-in host and tell it to call the registration function.
const char* args[] = { [pluginHostAppExecutablePath fileSystemRepresentation], "-createPluginMIMETypesPreferences", [bundlePath fileSystemRepresentation], 0 };
int result = posix_spawn(&pid, args[0], 0, &attr, const_cast<char* const*>(args), 0);
posix_spawnattr_destroy(&attr);
if (!result && pid > 0) {
// Wait for the process to finish.
while (waitpid(pid, 0, 0) == -1) { }
}
}
void NetscapePluginHostManager::didCreateWindow()
{
// See if any of our hosts are in full-screen mode.
PluginHostMap::iterator end = m_pluginHosts.end();
for (PluginHostMap::iterator it = m_pluginHosts.begin(); it != end; ++it) {
NetscapePluginHostProxy* hostProxy = it->second;
if (!hostProxy->isMenuBarVisible()) {
// Make ourselves the front process.
ProcessSerialNumber psn;
GetCurrentProcess(&psn);
SetFrontProcess(&psn);
return;
}
}
}
} // namespace WebKit
#endif // USE(PLUGIN_HOST_PROCESS)