Mozilla/mozilla/modules/plugin/base/src/nsPluginsDirDarwin.cpp
flamingice%sourmilk.net 9fd94c867a Bug 330108, ISO C++ forbids casting between pointer-to-function and pointer-to-object (use PR_FindFunctionSymbol), r=jst, sr=biesi
git-svn-id: svn://10.0.0.236/trunk@230126 18797224-902f-48f8-a5cc-f745e15eee43
2007-07-17 20:02:43 +00:00

423 lines
13 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is mozilla.org code.
*
* The Initial Developer of the Original Code is
* Netscape Communications Corporation.
* Portions created by the Initial Developer are Copyright (C) 1998
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Patrick C. Beard <beard@netscape.com>
* Josh Aas <josh@mozilla.com>
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/*
nsPluginsDirDarwin.cpp
Mac OS X implementation of the nsPluginsDir/nsPluginsFile classes.
by Patrick C. Beard.
*/
#include "prlink.h"
#include "prnetdb.h"
#include "nsPluginsDir.h"
#include "ns4xPlugin.h"
#include "nsPluginsDirUtils.h"
#include "nsILocalFileMac.h"
#include <string.h>
#include <stdio.h>
#include <unistd.h>
#include <fcntl.h>
#include <Carbon/Carbon.h>
#include <CoreServices/CoreServices.h>
#include <mach-o/loader.h>
#include <mach-o/fat.h>
typedef NS_4XPLUGIN_CALLBACK(const char *, NP_GETMIMEDESCRIPTION) ();
typedef NS_4XPLUGIN_CALLBACK(OSErr, BP_GETSUPPORTEDMIMETYPES) (BPSupportedMIMETypes *mimeInfo, UInt32 flags);
/*
** Returns a CFBundleRef if the FSSpec refers to a Mac OS X bundle directory.
** The caller is responsible for calling CFRelease() to deallocate.
*/
static CFBundleRef getPluginBundle(const char* path)
{
CFBundleRef bundle = NULL;
CFStringRef pathRef = CFStringCreateWithCString(NULL, path, kCFStringEncodingUTF8);
if (pathRef) {
CFURLRef bundleURL = CFURLCreateWithFileSystemPath(NULL, pathRef, kCFURLPOSIXPathStyle, true);
if (bundleURL != NULL) {
bundle = CFBundleCreate(NULL, bundleURL);
CFRelease(bundleURL);
}
CFRelease(pathRef);
}
return bundle;
}
static OSErr toFSSpec(nsIFile* file, FSSpec& outSpec)
{
nsCOMPtr<nsILocalFileMac> lfm = do_QueryInterface(file);
if (!lfm)
return -1;
FSSpec foo;
lfm->GetFSSpec(&foo);
outSpec = foo;
return NS_OK;
}
static nsresult toCFURLRef(nsIFile* file, CFURLRef& outURL)
{
nsCOMPtr<nsILocalFileMac> lfm = do_QueryInterface(file);
if (!lfm)
return NS_ERROR_FAILURE;
CFURLRef url;
nsresult rv = lfm->GetCFURL(&url);
if (NS_SUCCEEDED(rv))
outURL = url;
return rv;
}
// Opens the resource fork for the plugin
// Also checks if the plugin is a CFBundle and opens gets the correct resource
static short OpenPluginResourceFork(nsIFile *pluginFile)
{
FSSpec spec;
OSErr err = toFSSpec(pluginFile, spec);
Boolean targetIsFolder, wasAliased;
err = ::ResolveAliasFile(&spec, true, &targetIsFolder, &wasAliased);
short refNum = ::FSpOpenResFile(&spec, fsRdPerm);
if (refNum < 0) {
nsCString path;
pluginFile->GetNativePath(path);
CFBundleRef bundle = getPluginBundle(path.get());
if (bundle) {
refNum = CFBundleOpenBundleResourceMap(bundle);
CFRelease(bundle);
}
}
return refNum;
}
// function to test whether or not this is a loadable plugin
static PRBool IsLoadablePlugin(CFURLRef aURL)
{
if (!aURL)
return PR_FALSE;
PRBool isLoadable = PR_FALSE;
char path[PATH_MAX];
if (CFURLGetFileSystemRepresentation(aURL, TRUE, (UInt8*)path, sizeof(path))) {
UInt32 magic;
int f = open(path, O_RDONLY);
if (f != -1) {
// Mach-O headers use the byte ordering of the architecture on which
// they run, so test against the magic number in the byte order
// we're compiling for. Fat headers are always big-endian, so swap
// them to host before comparing to host representation of the magic
if (read(f, &magic, sizeof(magic)) == sizeof(magic)) {
if ((magic == MH_MAGIC) || (PR_ntohl(magic) == FAT_MAGIC))
isLoadable = PR_TRUE;
#ifdef __POWERPC__
// if we're on ppc, we can use CFM plugins
if (isLoadable == PR_FALSE) {
UInt32 magic2;
if (read(f, &magic2, sizeof(magic2)) == sizeof(magic2)) {
UInt32 cfm_header1 = 0x4A6F7921; // 'Joy!'
UInt32 cfm_header2 = 0x70656666; // 'peff'
if (cfm_header1 == magic && cfm_header2 == magic2)
isLoadable = PR_TRUE;
}
}
#endif
}
close(f);
}
}
return isLoadable;
}
PRBool nsPluginsDir::IsPluginFile(nsIFile* file)
{
CFURLRef pluginURL = NULL;
if (NS_FAILED(toCFURLRef(file, pluginURL)))
return PR_FALSE;
PRBool isPluginFile = PR_FALSE;
CFBundleRef pluginBundle = CFBundleCreate(kCFAllocatorDefault, pluginURL);
if (pluginBundle) {
UInt32 packageType, packageCreator;
CFBundleGetPackageInfo(pluginBundle, &packageType, &packageCreator);
if (packageType == 'BRPL' || packageType == 'IEPL' || packageType == 'NSPL') {
CFURLRef executableURL = CFBundleCopyExecutableURL(pluginBundle);
if (executableURL) {
isPluginFile = IsLoadablePlugin(executableURL);
CFRelease(executableURL);
}
}
// some WebKit plugins that we can't use don't have resource forks
short refNum;
if (isPluginFile) {
refNum = OpenPluginResourceFork(file);
if (refNum < 0) {
isPluginFile = PR_FALSE;
} else {
::CloseResFile(refNum);
}
}
CFRelease(pluginBundle);
}
else {
LSItemInfoRecord info;
if (LSCopyItemInfoForURL(pluginURL, kLSRequestTypeCreator, &info) == noErr) {
if ((info.filetype == 'shlb' && info.creator == 'MOSS') ||
info.filetype == 'NSPL' ||
info.filetype == 'BRPL' ||
info.filetype == 'IEPL') {
isPluginFile = IsLoadablePlugin(pluginURL);
}
}
}
CFRelease(pluginURL);
return isPluginFile;
}
nsPluginFile::nsPluginFile(nsIFile *spec)
: mPlugin(spec)
{
}
nsPluginFile::~nsPluginFile() {}
/**
* Loads the plugin into memory using NSPR's shared-library loading
* mechanism. Handles platform differences in loading shared libraries.
*/
nsresult nsPluginFile::LoadPlugin(PRLibrary* &outLibrary)
{
const char* path;
if (!mPlugin)
return NS_ERROR_NULL_POINTER;
nsCAutoString temp;
mPlugin->GetNativePath(temp);
path = temp.get();
outLibrary = PR_LoadLibrary(path);
pLibrary = outLibrary;
if (!outLibrary) {
return NS_ERROR_FAILURE;
}
#ifdef DEBUG
printf("[loaded plugin %s]\n", path);
#endif
return NS_OK;
}
static char* p2cstrdup(StringPtr pstr)
{
int len = pstr[0];
char* cstr = new char[len + 1];
if (cstr != NULL) {
::BlockMoveData(pstr + 1, cstr, len);
cstr[len] = '\0';
}
return cstr;
}
static char* GetNextPluginStringFromHandle(Handle h, short *index)
{
char *ret = p2cstrdup((unsigned char*)(*h + *index));
*index += (ret ? PL_strlen(ret) : 0) + 1;
return ret;
}
static char* GetPluginString(short id, short index)
{
Str255 str;
::GetIndString(str, id, index);
return p2cstrdup(str);
}
short nsPluginFile::OpenPluginResource()
{
return OpenPluginResourceFork(mPlugin);
}
/**
* Obtains all of the information currently available for this plugin.
*/
nsresult nsPluginFile::GetPluginInfo(nsPluginInfo& info)
{
// clear out the info, except for the first field.
memset(&info.fName, 0, sizeof(info) - sizeof(PRUint32));
if (info.fPluginInfoSize < sizeof(nsPluginInfo))
return NS_ERROR_FAILURE;
// need to open the plugin's resource file and read some resources.
short refNum = OpenPluginResource();
if (refNum < 0)
return NS_ERROR_FAILURE;
// 'STR#', 126, 2 => plugin name.
info.fName = GetPluginString(126, 2);
// 'STR#', 126, 1 => plugin description.
info.fDescription = GetPluginString(126, 1);
nsCString path;
mPlugin->GetNativePath(path);
FSSpec spec;
toFSSpec(mPlugin, spec);
info.fFileName = p2cstrdup(spec.name);
info.fFullPath = PL_strdup(path.get());
CFBundleRef bundle = getPluginBundle(path.get());
if (bundle) {
info.fBundle = PR_TRUE;
CFRelease(bundle);
}
else {
info.fBundle = PR_FALSE;
}
// It's possible that our plugin has 2 special extra entry points that'll give us more
// mime type info. Quicktime does this to get around the need of having admin rights
// to change mime info in the resource fork. We need to use this info instead of the
// resource. See bug 113464.
BPSupportedMIMETypes mi = {kBPSupportedMIMETypesStructVers_1, NULL, NULL};
if (pLibrary) {
// First, check for NP_GetMIMEDescription
NP_GETMIMEDESCRIPTION pfnGetMimeDesc =
(NP_GETMIMEDESCRIPTION)PR_FindFunctionSymbol(pLibrary, NP_GETMIMEDESCRIPTION_NAME);
if (pfnGetMimeDesc) {
nsresult rv = ParsePluginMimeDescription(pfnGetMimeDesc(), info);
if (NS_SUCCEEDED(rv)) { // if we could parse the mime types from NP_GetMIMEDescription,
::CloseResFile(refNum); // we've got what we need, close the resource, we're done
return rv;
}
}
// Next check for mime info from BP_GetSupportedMIMETypes
BP_GETSUPPORTEDMIMETYPES pfnMime =
(BP_GETSUPPORTEDMIMETYPES)PR_FindFunctionSymbol(pLibrary, "BP_GetSupportedMIMETypes");
if (pfnMime && noErr == pfnMime(&mi, 0) && mi.typeStrings) {
info.fVariantCount = (**(short**)mi.typeStrings) / 2;
::HLock(mi.typeStrings);
if (mi.infoStrings) // it's possible some plugins have infoStrings missing
::HLock(mi.infoStrings);
}
}
// Last, we couldn't get info from an extra entry point for some reason,
// Lets get info from normal resources
if (!info.fVariantCount) {
mi.typeStrings = ::Get1Resource('STR#', 128);
if (mi.typeStrings) {
info.fVariantCount = (**(short**)mi.typeStrings) / 2;
::DetachResource(mi.typeStrings);
::HLock(mi.typeStrings);
} else {
// Don't add this plugin because no mime types could be found
::CloseResFile(refNum);
return NS_ERROR_FAILURE;
}
mi.infoStrings = ::Get1Resource('STR#', 127);
if (mi.infoStrings) {
::DetachResource(mi.infoStrings);
::HLock(mi.infoStrings);
}
}
// fill-in rest of info struct
int variantCount = info.fVariantCount;
info.fMimeTypeArray = new char*[variantCount];
info.fExtensionArray = new char*[variantCount];
if (mi.infoStrings)
info.fMimeDescriptionArray = new char*[variantCount];
short mimeIndex = 2, descriptionIndex = 2;
for (int i = 0; i < variantCount; i++) {
info.fMimeTypeArray[i] = GetNextPluginStringFromHandle(mi.typeStrings, &mimeIndex);
info.fExtensionArray[i] = GetNextPluginStringFromHandle(mi.typeStrings, &mimeIndex);
if (mi.infoStrings)
info.fMimeDescriptionArray[i] = GetNextPluginStringFromHandle(mi.infoStrings, &descriptionIndex);
}
::HUnlock(mi.typeStrings);
::DisposeHandle(mi.typeStrings);
if (mi.infoStrings) {
::HUnlock(mi.infoStrings);
::DisposeHandle(mi.infoStrings);
}
::CloseResFile(refNum);
return NS_OK;
}
nsresult nsPluginFile::FreePluginInfo(nsPluginInfo& info)
{
if (info.fPluginInfoSize <= sizeof(nsPluginInfo)) {
delete[] info.fName;
delete[] info.fDescription;
int variantCount = info.fVariantCount;
for (int i = 0; i < variantCount; i++) {
delete[] info.fMimeTypeArray[i];
delete[] info.fExtensionArray[i];
delete[] info.fMimeDescriptionArray[i];
}
delete[] info.fMimeTypeArray;
delete[] info.fMimeDescriptionArray;
delete[] info.fExtensionArray;
delete[] info.fFileName;
delete[] info.fFullPath;
}
return NS_OK;
}