summaryrefslogtreecommitdiffstats
path: root/dom/plugins/base/nsPluginHost.h
diff options
context:
space:
mode:
Diffstat (limited to 'dom/plugins/base/nsPluginHost.h')
-rw-r--r--dom/plugins/base/nsPluginHost.h465
1 files changed, 465 insertions, 0 deletions
diff --git a/dom/plugins/base/nsPluginHost.h b/dom/plugins/base/nsPluginHost.h
new file mode 100644
index 000000000..27e90c991
--- /dev/null
+++ b/dom/plugins/base/nsPluginHost.h
@@ -0,0 +1,465 @@
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+#ifndef nsPluginHost_h_
+#define nsPluginHost_h_
+
+#include "nsIPluginHost.h"
+#include "nsIObserver.h"
+#include "nsCOMPtr.h"
+#include "prlink.h"
+#include "prclist.h"
+#include "nsIPluginTag.h"
+#include "nsPluginsDir.h"
+#include "nsPluginDirServiceProvider.h"
+#include "nsWeakPtr.h"
+#include "nsIPrompt.h"
+#include "nsWeakReference.h"
+#include "MainThreadUtils.h"
+#include "nsTArray.h"
+#include "nsTObserverArray.h"
+#include "nsITimer.h"
+#include "nsPluginTags.h"
+#include "nsIEffectiveTLDService.h"
+#include "nsIIDNService.h"
+#include "nsCRT.h"
+
+#ifdef XP_WIN
+#include <minwindef.h>
+#include "nsIWindowsRegKey.h"
+#endif
+
+namespace mozilla {
+namespace plugins {
+class PluginAsyncSurrogate;
+class PluginTag;
+} // namespace plugins
+} // namespace mozilla
+
+class nsNPAPIPlugin;
+class nsIFile;
+class nsIChannel;
+class nsPluginNativeWindow;
+class nsObjectLoadingContent;
+class nsPluginInstanceOwner;
+class nsPluginUnloadRunnable;
+class nsNPAPIPluginInstance;
+class nsNPAPIPluginStreamListener;
+class nsIPluginInstanceOwner;
+class nsIInputStream;
+class nsIStreamListener;
+#ifndef npapi_h_
+struct _NPP;
+typedef _NPP* NPP;
+#endif
+
+class nsInvalidPluginTag : public nsISupports
+{
+ virtual ~nsInvalidPluginTag();
+public:
+ explicit nsInvalidPluginTag(const char* aFullPath, int64_t aLastModifiedTime = 0);
+
+ NS_DECL_ISUPPORTS
+
+ nsCString mFullPath;
+ int64_t mLastModifiedTime;
+ bool mSeen;
+
+ RefPtr<nsInvalidPluginTag> mPrev;
+ RefPtr<nsInvalidPluginTag> mNext;
+};
+
+class nsPluginHost final : public nsIPluginHost,
+ public nsIObserver,
+ public nsITimerCallback,
+ public nsSupportsWeakReference
+{
+ friend class nsPluginTag;
+ friend class nsFakePluginTag;
+ virtual ~nsPluginHost();
+
+public:
+ nsPluginHost();
+
+ static already_AddRefed<nsPluginHost> GetInst();
+
+ NS_DECL_AND_IMPL_ZEROING_OPERATOR_NEW
+
+ NS_DECL_ISUPPORTS
+ NS_DECL_NSIPLUGINHOST
+ NS_DECL_NSIOBSERVER
+ NS_DECL_NSITIMERCALLBACK
+
+ nsresult LoadPlugins();
+ nsresult UnloadPlugins();
+
+ nsresult SetUpPluginInstance(const nsACString &aMimeType,
+ nsIURI *aURL,
+ nsPluginInstanceOwner *aOwner);
+
+ // Acts like a bitfield
+ enum PluginFilter {
+ eExcludeNone = nsIPluginHost::EXCLUDE_NONE,
+ eExcludeDisabled = nsIPluginHost::EXCLUDE_DISABLED,
+ eExcludeFake = nsIPluginHost::EXCLUDE_FAKE
+ };
+ // FIXME-jsplugins comment about fake
+ bool HavePluginForType(const nsACString & aMimeType,
+ PluginFilter aFilter = eExcludeDisabled);
+
+ // FIXME-jsplugins what if fake has different extensions
+ bool HavePluginForExtension(const nsACString & aExtension,
+ /* out */ nsACString & aMimeType,
+ PluginFilter aFilter = eExcludeDisabled);
+
+ void GetPlugins(nsTArray<nsCOMPtr<nsIInternalPluginTag>>& aPluginArray,
+ bool aIncludeDisabled = false);
+
+ nsresult FindPluginsForContent(uint32_t aPluginEpoch,
+ nsTArray<mozilla::plugins::PluginTag>* aPlugins,
+ uint32_t* aNewPluginEpoch);
+
+ nsresult GetURL(nsISupports* pluginInst,
+ const char* url,
+ const char* target,
+ nsNPAPIPluginStreamListener* streamListener,
+ const char* altHost,
+ const char* referrer,
+ bool forceJSEnabled);
+ nsresult PostURL(nsISupports* pluginInst,
+ const char* url,
+ uint32_t postDataLen,
+ const char* postData,
+ bool isFile,
+ const char* target,
+ nsNPAPIPluginStreamListener* streamListener,
+ const char* altHost,
+ const char* referrer,
+ bool forceJSEnabled,
+ uint32_t postHeadersLength,
+ const char* postHeaders);
+
+ nsresult FindProxyForURL(const char* url, char* *result);
+ nsresult UserAgent(const char **retstring);
+ nsresult ParsePostBufferToFixHeaders(const char *inPostData,
+ uint32_t inPostDataLen,
+ char **outPostData,
+ uint32_t *outPostDataLen);
+ nsresult CreateTempFileToPost(const char *aPostDataURL, nsIFile **aTmpFile);
+ nsresult NewPluginNativeWindow(nsPluginNativeWindow ** aPluginNativeWindow);
+
+ void AddIdleTimeTarget(nsIPluginInstanceOwner* objectFrame, bool isVisible);
+ void RemoveIdleTimeTarget(nsIPluginInstanceOwner* objectFrame);
+
+ nsresult GetPluginName(nsNPAPIPluginInstance *aPluginInstance,
+ const char** aPluginName);
+ nsresult StopPluginInstance(nsNPAPIPluginInstance* aInstance);
+ nsresult GetPluginTagForInstance(nsNPAPIPluginInstance *aPluginInstance,
+ nsIPluginTag **aPluginTag);
+
+ nsresult
+ NewPluginURLStream(const nsString& aURL,
+ nsNPAPIPluginInstance *aInstance,
+ nsNPAPIPluginStreamListener *aListener,
+ nsIInputStream *aPostStream = nullptr,
+ const char *aHeadersData = nullptr,
+ uint32_t aHeadersDataLen = 0);
+
+ nsresult
+ GetURLWithHeaders(nsNPAPIPluginInstance *pluginInst,
+ const char* url,
+ const char* target = nullptr,
+ nsNPAPIPluginStreamListener* streamListener = nullptr,
+ const char* altHost = nullptr,
+ const char* referrer = nullptr,
+ bool forceJSEnabled = false,
+ uint32_t getHeadersLength = 0,
+ const char* getHeaders = nullptr);
+
+ nsresult
+ AddHeadersToChannel(const char *aHeadersData, uint32_t aHeadersDataLen,
+ nsIChannel *aGenericChannel);
+
+ static nsresult GetPluginTempDir(nsIFile **aDir);
+
+ // Helper that checks if a type is whitelisted in plugin.allowed_types.
+ // Always returns true if plugin.allowed_types is not set
+ static bool IsTypeWhitelisted(const char *aType);
+
+ // Helper that checks if a plugin of a given MIME type can be loaded by the
+ // parent process. It checks the plugin.load_in_parent_process.<mime> pref.
+ // Always returns false if plugin.load_in_parent_process.<mime> is not set.
+ static bool ShouldLoadTypeInParent(const nsACString& aMimeType);
+
+ // checks whether aType is a type we recognize for potential special handling
+ enum SpecialType { eSpecialType_None,
+ // Needed to whitelist for async init support
+ eSpecialType_Test,
+ // Informs some decisions about OOP and quirks
+ eSpecialType_Flash,
+ // Binds to the <applet> tag, has various special
+ // rules around opening channels, codebase, ...
+ eSpecialType_Java,
+ // Some IPC quirks
+ eSpecialType_Silverlight,
+ // Native widget quirks
+ eSpecialType_PDF,
+ // Native widget quirks
+ eSpecialType_RealPlayer,
+ // Native widget quirks
+ eSpecialType_Unity };
+ static SpecialType GetSpecialType(const nsACString & aMIMEType);
+
+ static nsresult PostPluginUnloadEvent(PRLibrary* aLibrary);
+
+ void PluginCrashed(nsNPAPIPlugin* plugin,
+ const nsAString& pluginDumpID,
+ const nsAString& browserDumpID);
+
+ nsNPAPIPluginInstance *FindInstance(const char *mimetype);
+ nsNPAPIPluginInstance *FindOldestStoppedInstance();
+ uint32_t StoppedInstanceCount();
+
+ nsTArray< RefPtr<nsNPAPIPluginInstance> > *InstanceArray();
+
+ // Return the tag for |aLibrary| if found, nullptr if not.
+ nsPluginTag* FindTagForLibrary(PRLibrary* aLibrary);
+
+ // The last argument should be false if we already have an in-flight stream
+ // and don't need to set up a new stream.
+ nsresult InstantiatePluginInstance(const nsACString& aMimeType, nsIURI* aURL,
+ nsObjectLoadingContent *aContent,
+ nsPluginInstanceOwner** aOwner);
+
+ // Does not accept nullptr and should never fail.
+ nsPluginTag* TagForPlugin(nsNPAPIPlugin* aPlugin);
+
+ nsPluginTag* PluginWithId(uint32_t aId);
+
+ nsresult GetPlugin(const nsACString &aMimeType, nsNPAPIPlugin** aPlugin);
+ nsresult GetPluginForContentProcess(uint32_t aPluginId, nsNPAPIPlugin** aPlugin);
+ void NotifyContentModuleDestroyed(uint32_t aPluginId);
+
+ nsresult NewPluginStreamListener(nsIURI* aURL,
+ nsNPAPIPluginInstance* aInstance,
+ nsIStreamListener **aStreamListener);
+
+ void CreateWidget(nsPluginInstanceOwner* aOwner);
+
+ nsresult EnumerateSiteData(const nsACString& domain,
+ const InfallibleTArray<nsCString>& sites,
+ InfallibleTArray<nsCString>& result,
+ bool firstMatchOnly);
+
+private:
+ friend class nsPluginUnloadRunnable;
+
+ void DestroyRunningInstances(nsPluginTag* aPluginTag);
+
+ // Writes updated plugins settings to disk and unloads the plugin
+ // if it is now disabled. Should only be called by the plugin tag in question
+ void UpdatePluginInfo(nsPluginTag* aPluginTag);
+
+ nsresult TrySetUpPluginInstance(const nsACString &aMimeType, nsIURI *aURL,
+ nsPluginInstanceOwner *aOwner);
+
+ // FIXME-jsplugins comment here about when things may be fake
+ nsPluginTag*
+ FindPreferredPlugin(const InfallibleTArray<nsPluginTag*>& matches);
+
+ // Find a plugin for the given type. If aIncludeFake is true a fake plugin
+ // will be preferred if one exists; otherwise a fake plugin will never be
+ // returned. If aCheckEnabled is false, disabled plugins can be returned.
+ nsIInternalPluginTag* FindPluginForType(const nsACString& aMimeType,
+ bool aIncludeFake, bool aCheckEnabled);
+
+ // Find specifically a fake plugin for the given type. If aCheckEnabled is
+ // false, disabled plugins can be returned.
+ nsFakePluginTag* FindFakePluginForType(const nsACString & aMimeType,
+ bool aCheckEnabled);
+
+ // Find specifically a fake plugin for the given extension. If aCheckEnabled
+ // is false, disabled plugins can be returned. aMimeType will be filled in
+ // with the MIME type the plugin is registered for.
+ nsFakePluginTag* FindFakePluginForExtension(const nsACString & aExtension,
+ /* out */ nsACString & aMimeType,
+ bool aCheckEnabled);
+
+ // Find specifically a native (NPAPI) plugin for the given type. If
+ // aCheckEnabled is false, disabled plugins can be returned.
+ nsPluginTag* FindNativePluginForType(const nsACString & aMimeType,
+ bool aCheckEnabled);
+
+ // Find specifically a native (NPAPI) plugin for the given extension. If
+ // aCheckEnabled is false, disabled plugins can be returned. aMimeType will
+ // be filled in with the MIME type the plugin is registered for.
+ nsPluginTag* FindNativePluginForExtension(const nsACString & aExtension,
+ /* out */ nsACString & aMimeType,
+ bool aCheckEnabled);
+
+ nsresult
+ FindStoppedPluginForURL(nsIURI* aURL, nsIPluginInstanceOwner *aOwner);
+
+ nsresult FindPluginsInContent(bool aCreatePluginList, bool * aPluginsChanged);
+
+ nsresult
+ FindPlugins(bool aCreatePluginList, bool * aPluginsChanged);
+
+ // FIXME revisit, no ns prefix
+ // Registers or unregisters the given mime type with the category manager
+ enum nsRegisterType { ePluginRegister,
+ ePluginUnregister,
+ // Checks if this type should still be registered first
+ ePluginMaybeUnregister };
+ void RegisterWithCategoryManager(const nsCString& aMimeType,
+ nsRegisterType aType);
+
+ void AddPluginTag(nsPluginTag* aPluginTag);
+
+ nsresult
+ ScanPluginsDirectory(nsIFile *pluginsDir,
+ bool aCreatePluginList,
+ bool *aPluginsChanged);
+
+ nsresult
+ ScanPluginsDirectoryList(nsISimpleEnumerator *dirEnum,
+ bool aCreatePluginList,
+ bool *aPluginsChanged);
+
+ nsresult EnsurePluginLoaded(nsPluginTag* aPluginTag);
+
+ bool IsRunningPlugin(nsPluginTag * aPluginTag);
+
+ // Stores all plugins info into the registry
+ nsresult WritePluginInfo();
+
+ // Loads all cached plugins info into mCachedPlugins
+ nsresult ReadPluginInfo();
+
+ // Given a file path, returns the plugins info from our cache
+ // and removes it from the cache.
+ void RemoveCachedPluginsInfo(const char *filePath,
+ nsPluginTag **result);
+
+ // Checks to see if a tag object is in our list of live tags.
+ bool IsLiveTag(nsIPluginTag* tag);
+
+ // Checks our list of live tags for an equivalent tag.
+ nsPluginTag* HaveSamePlugin(const nsPluginTag * aPluginTag);
+
+ // Returns the first plugin at |path|
+ nsPluginTag* FirstPluginWithPath(const nsCString& path);
+
+ nsresult EnsurePrivateDirServiceProvider();
+
+ void OnPluginInstanceDestroyed(nsPluginTag* aPluginTag);
+
+ // To be used by the chrome process whenever the set of plugins changes.
+ void IncrementChromeEpoch();
+
+ // To be used by the chrome process; returns the current epoch.
+ uint32_t ChromeEpoch();
+
+ // To be used by the content process to get/set the last observed epoch value
+ // from the chrome process.
+ uint32_t ChromeEpochForContent();
+ void SetChromeEpochForContent(uint32_t aEpoch);
+
+ void UpdateInMemoryPluginInfo(nsPluginTag* aPluginTag);
+
+ // On certain platforms, we only want to load certain plugins. This function
+ // centralizes loading rules.
+ bool ShouldAddPlugin(nsPluginTag* aPluginTag);
+
+ RefPtr<nsPluginTag> mPlugins;
+ RefPtr<nsPluginTag> mCachedPlugins;
+ RefPtr<nsInvalidPluginTag> mInvalidPlugins;
+
+ nsTArray< RefPtr<nsFakePluginTag> > mFakePlugins;
+
+ bool mPluginsLoaded;
+
+ // set by pref plugin.override_internal_types
+ bool mOverrideInternalTypes;
+
+ // set by pref plugin.disable
+ bool mPluginsDisabled;
+
+ // Any instances in this array will have valid plugin objects via GetPlugin().
+ // When removing an instance it might not die - be sure to null out it's plugin.
+ nsTArray< RefPtr<nsNPAPIPluginInstance> > mInstances;
+
+ nsCOMPtr<nsIFile> mPluginRegFile;
+#ifdef XP_WIN
+ RefPtr<nsPluginDirServiceProvider> mPrivateDirServiceProvider;
+
+ // In order to reload plugins when they change, we watch the registry via
+ // this object.
+ nsCOMPtr<nsIWindowsRegKey> mRegKeyHKLM;
+ nsCOMPtr<nsIWindowsRegKey> mRegKeyHKCU;
+#endif
+
+ nsCOMPtr<nsIEffectiveTLDService> mTLDService;
+ nsCOMPtr<nsIIDNService> mIDNService;
+
+ // Helpers for ClearSiteData and SiteHasData.
+ nsresult NormalizeHostname(nsCString& host);
+
+ nsWeakPtr mCurrentDocument; // weak reference, we use it to id document only
+
+ // This epoch increases each time we load the list of plugins from disk.
+ // In the chrome process, this stores the actual epoch.
+ // In the content process, this stores the last epoch value observed
+ // when reading plugins from chrome.
+ uint32_t mPluginEpoch;
+
+ static nsIFile *sPluginTempDir;
+
+ // We need to hold a global ptr to ourselves because we register for
+ // two different CIDs for some reason...
+ static nsPluginHost* sInst;
+};
+
+class PluginDestructionGuard : protected PRCList
+{
+public:
+ explicit PluginDestructionGuard(nsNPAPIPluginInstance *aInstance);
+ explicit PluginDestructionGuard(mozilla::plugins::PluginAsyncSurrogate *aSurrogate);
+ explicit PluginDestructionGuard(NPP npp);
+
+ ~PluginDestructionGuard();
+
+ static bool DelayDestroy(nsNPAPIPluginInstance *aInstance);
+
+protected:
+ void Init()
+ {
+ NS_ASSERTION(NS_IsMainThread(), "Should be on the main thread");
+
+ mDelayedDestroy = false;
+
+ PR_INIT_CLIST(this);
+ PR_INSERT_BEFORE(this, &sListHead);
+ }
+
+ void InitAsync()
+ {
+ NS_ASSERTION(NS_IsMainThread(), "Should be on the main thread");
+
+ mDelayedDestroy = false;
+
+ PR_INIT_CLIST(this);
+ // Instances with active surrogates must be inserted *after* sListHead so
+ // that they appear to be at the bottom of the stack
+ PR_INSERT_AFTER(this, &sListHead);
+ }
+
+ RefPtr<nsNPAPIPluginInstance> mInstance;
+ bool mDelayedDestroy;
+
+ static PRCList sListHead;
+};
+
+#endif // nsPluginHost_h_