nsIPluginHost

Method overview

Attributes

Methods

To create temp file with Content len header in, it will use by http POST.

nsIFile createTempFileToPost(
  in string aPostDataURL
);

Parameters

aPostDataURL

 

Return value

To create temp file with Content len header in, it will use by http POST.

void createTmpFileToPost(
  in string aPostDataURL,
  out string aTmpFileName
);

Parameters

aPostDataURL

 

aTmpFileName

 

Deletes plugin native window object created by NewPluginNativeWindow().

void deletePluginNativeWindow(
  in nsPluginNativeWindowPtr aPluginNativeWindow
);

Parameters

aPluginNativeWindow

 

void destroy();

Parameters

None.

Fetches a URL.

(Corresponds to NPN_GetURL and NPN_GetURLNotify.)

Posts to a URL with post data and/or post headers.

(Corresponds to NPN_PostURL and NPN_PostURLNotify.)

Returns the proxy info for a given URL. The caller is required to free the resulting memory with nsIMalloc.Free(). The result will be in the following format.

1. "DIRECT" -- no proxy
2. "PROXY xxx.xxx.xxx.xxx" -- use proxy
3. "SOCKS xxx.xxx.xxx.xxx" -- use SOCKS
4. Mixed. for example "PROXY 111.111.111.111;PROXY 112.112.112.112", "PROXY 111.111.111.111;SOCKS 112.112.112.112"....

Which proxy/SOCKS to use is determined by the plugin.

void findProxyForURL(
  in string aURL,
  out string aResult
);

Parameters

aURL

 

aResult

 

nsIPlugin getPlugin(
  in string aMimeType
);

Parameters

aMimeType

 

Return value

void getPluginCount(
  out unsigned long aPluginCount
);

Parameters

aPluginCount

 

nsIPlugin getPluginFactory(
  in string aMimeType
);

Parameters

aMimeType

 

Return value

Get the plugin name for the plugin instance.

void getPluginName(
  in nsIPluginInstance aInstance,
  [shared] out string aPluginName
);

Parameters

aInstance

The plugin instance object.

aPluginName

Returns a pointer to a shared read-only string value, it's only valid for the lifetime of the plugin instance - you must copy the string value if you need it longer than that.

Get the plugin tag associated with a given plugin instance.

nsIPluginTag getPluginTagForInstance(
  in nsIPluginInstance aInstance
);

Parameters

aInstance

The plugin instance object.

Return value

Plugin tag object.

void getPluginTags(
  out unsigned long aPluginCount, Optional
  [retval, array, size_is(aPluginCount)] out nsIPluginTag aResults
);

Parameters

aPluginCount Optional

 

aResults

 

void handleBadPlugin(
  in PRLibraryPtr aLibrary,
  in nsIPluginInstance instance
);

Parameters

aLibrary

 

instance

 

void init();

Parameters

None.

Instantiate a "dummy" java plugin if a java plugin that supports NPRuntime is installed. This plugin is used for exposing window.java and window.Packages. If the java plugin supports NPRuntime and instantiation was successful, aOwners instance will be non-null, if not, it will be null.

void instantiateDummyJavaPlugin(
  in nsIPluginInstanceOwner aOwner
);

Parameters

aOwner

 

void instantiateEmbeddedPlugin(
  in string aMimeType,
  in nsIURI aURL,
  in nsIPluginInstanceOwner aOwner
);

Parameters

aMimeType

 

aURL

 

aOwner

 

void instantiateEmbededPlugin(
  in string aMimeType,
  in nsIURI aURL,
  in nsIPluginInstanceOwner aOwner
);

Parameters

aMimeType

 

aURL

 

aOwner

 

void instantiateFullPagePlugin(
  in string aMimeType,
  in nsIURI aURI,
  in nsIPluginInstanceOwner aOwner,
  out nsIStreamListener aStreamListener
);

Parameters

aMimeType

 

aURI

 

aOwner

 

aStreamListener

 

Instantiate an embedded plugin for an existing channel. The caller is responsible for opening the channel. It may or may not be already opened when this function is called.

nsIStreamListener instantiatePluginForChannel(
  in nsIChannel aChannel,
  in nsIPluginInstanceOwner aOwner
);

Parameters

aChannel

 

aOwner

 

Return value

void isPluginEnabledForExtension(
  in string aExtension,
  in constCharStarRef aMimeType
);

Parameters

aExtension

 

aMimeType

 

void isPluginEnabledForType(
  in string aMimeType
);

Parameters

aMimeType

 

void loadPlugins();

Parameters

None.

Creates a new plugin native window object.

void newPluginNativeWindow(
  out nsPluginNativeWindowPtr aPluginNativeWindow
);

Parameters

aPluginNativeWindow

 

This method parses post buffer to find out case insensitive "Content-length" string and CR or LF some where after that, then it assumes there is http headers in the input buffer and continue to search for end of headers (CRLFCRLF or LFLF). It will *always malloc()* output buffer (caller is responsible to free it) if input buffer starts with LF, which comes from 4.x spec http://developer.netscape.com/docs/manuals/communicator/plugin/pgfn2.htm#1007754 "If no custom headers are required, simply add a blank line ('\n') to the beginning of the file or buffer.", it skips that '\n' and considers rest of the input buffer as data. If "Content-length" string and end of headers is found it substitutes single LF with CRLF in the headers, so the end of headers always will be CRLFCRLF (single CR in headers, if any, remain untouched) else it puts "Content-length: "+size_of_data+CRLFCRLF at the beginning of the output buffer and memcpy data to the output buffer.

On failure outPostData and outPostDataLen will be set in 0.

void parsePostBufferToFixHeaders(
  in string aInPostData,
  in unsigned long aInPostDataLen,
  out string aOutPostData,
  out unsigned long aOutPostDataLen
);

Parameters

aInPostData

The post data.

aInPostDataLen

The length aInPostData.

aOutPostData

The buffer.

aOutPostDataLen

The length of aOutPostData.

Causes the plugins directory to be searched again for new plugin libraries.

void reloadPlugins(
  in boolean reloadPages
);

Parameters

reloadPages

Indicates whether currently visible pages should also be reloaded.

To notify the plugin manager that the plugin created a script object.

void setIsScriptableInstance(
  in nsIPluginInstance aInstance,
  in boolean aScriptable
);

Parameters

aInstance

 

aScriptable

 

void setUpPluginInstance(
  in string aMimeType,
  in nsIURI aURL,
  in nsIPluginInstanceOwner aOwner
);

Parameters

aMimeType

 

aURL

 

aOwner

 

void stopPluginInstance(
  in nsIPluginInstance aInstance
);

Parameters

aInstance

 

void UserAgent(
  in nativeChar resultingAgentString
);

Parameters

Examples

List all plug-ins and associated mime types and get handler info

This example here logs to Browser Console all the installed plug-ins and the associated mime types. Then using nsIHandlerService it gets the handler info. A handler is, default application that should open or deal with this file.

let pluginHost = Cc["@mozilla.org/plugin/host;1"].getService(Ci.nsIPluginHost);
let handlerService = Cc['@mozilla.org/uriloader/handler-service;1'].getService(Ci.nsIHandlerService);
let mimeService = Cc['@mozilla.org/mime;1'].getService(Ci.nsIMIMEService);
let pluginTags = pluginHost.getPluginTags();
for (let i = 0; i < pluginTags.length; ++i) {
    let pluginTag = pluginTags[i];
    let mimeTypes = pluginTag.getMimeTypes();
    console.warn('pluginTag:', pluginTag.name, 'mimeTypes:', mimeTypes);
    // go through all the mime types and get the handler service
    for (let j = 0; j < mimeTypes.length; ++j) {
        let type = mimeTypes[j];
        let wrappedHandlerInfo = mimeService.getFromTypeAndExtension(type, null);
        console.log('handler info for type', type, wrappedHandlerInfo);
    }
}

resultingAgentString