fune/dom/base/nsMimeTypeArray.h
David Parks af5370612f Bug 1720353: Implement new navigator.{plugins,mimeTypes,pdfViewerSupported} specs r=peterv
This implements the new HTML spec for these fields, which now serve hard-coded values, depending on whether or not PDFs are supported.  The values were deemed important to maintain web compatibility.  The spec can be found in section 8.9.1.6:

https://html.spec.whatwg.org/multipage/system-state.html#pdf-viewing-support

The web-compat test for this can be found at:

https://wpt.live/html/webappapis/system-state-and-capabilities/the-navigator-object/plugins-and-mimetypes.html

This patch follows the spec for the PDF plugins if "pdfjs.disabled" is false.  It also produces empty plugin arrays if "pdfjs.disabled" is true, as per the spec.  Both cases are tested by the wpt.live page.

Differential Revision: https://phabricator.services.mozilla.com/D133291
2022-02-17 01:33:00 +00:00

114 lines
3.5 KiB
C++

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* 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 nsMimeTypeArray_h___
#define nsMimeTypeArray_h___
#include "nsWrapperCache.h"
#include "nsCOMPtr.h"
#include "nsPIDOMWindow.h"
#include "nsTArray.h"
#include "mozilla/dom/BindingDeclarations.h"
class nsMimeType;
class nsPluginElement;
/**
* Array class backing HTML's navigator.mimeTypes. This always holds
* references to the hard-coded set of PDF MIME types defined by HTML but it
* only consults them if "pdfjs.disabled" is false. There is never more
* than one of these per DOM window.
*/
class nsMimeTypeArray final : public nsISupports, public nsWrapperCache {
public:
nsMimeTypeArray(nsPIDOMWindowInner* aWindow,
const mozilla::Array<RefPtr<nsMimeType>, 2>& aMimeTypes);
NS_DECL_CYCLE_COLLECTING_ISUPPORTS
NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_CLASS(nsMimeTypeArray)
nsPIDOMWindowInner* GetParentObject() const;
virtual JSObject* WrapObject(JSContext* aCx,
JS::Handle<JSObject*> aGivenProto) override;
// MimeTypeArray WebIDL methods
uint32_t Length() { return ForceNoPlugins() ? 0 : ArrayLength(mMimeTypes); }
nsMimeType* Item(uint32_t aIndex) {
bool unused;
return IndexedGetter(aIndex, unused);
}
nsMimeType* NamedItem(const nsAString& aName) {
bool unused;
return NamedGetter(aName, unused);
}
nsMimeType* IndexedGetter(uint32_t index, bool& found);
nsMimeType* NamedGetter(const nsAString& name, bool& found);
void GetSupportedNames(nsTArray<nsString>& retval);
protected:
virtual ~nsMimeTypeArray();
static bool ForceNoPlugins();
nsCOMPtr<nsPIDOMWindowInner> mWindow;
mozilla::Array<RefPtr<nsMimeType>, 2> mMimeTypes;
};
/**
* Mime type class backing entries in HTML's navigator.mimeTypes array. There
* is a fixed set of these, as defined by HTML.
*/
class nsMimeType final : public nsWrapperCache {
public:
NS_INLINE_DECL_CYCLE_COLLECTING_NATIVE_REFCOUNTING(nsMimeType)
NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_NATIVE_CLASS(nsMimeType)
nsMimeType(nsPluginElement* aPluginElement, const nsAString& aName);
nsPluginElement* GetParentObject() const { return mPluginElement; }
virtual JSObject* WrapObject(JSContext* aCx,
JS::Handle<JSObject*> aGivenProto) override;
// MimeType WebIDL methods
void GetDescription(mozilla::dom::DOMString& retval) const {
retval.SetKnownLiveString(kMimeDescription);
}
already_AddRefed<nsPluginElement> EnabledPlugin() const {
return do_AddRef(mPluginElement);
}
void GetSuffixes(mozilla::dom::DOMString& retval) const {
retval.SetKnownLiveString(kMimeSuffix);
}
void GetType(nsString& retval) const { retval = mName; }
const nsString& Name() const { return mName; }
protected:
virtual ~nsMimeType();
static constexpr nsLiteralString kMimeDescription =
u"Portable Document Format"_ns;
static constexpr nsLiteralString kMimeSuffix = u"pdf"_ns;
// Note that this creates an explicit reference cycle:
//
// nsMimeType -> nsPluginElement -> nsPluginArray ->
// nsMimeTypeArray -> nsMimeType
//
// We rely on the cycle collector to break this cycle.
RefPtr<nsPluginElement> mPluginElement;
nsString mName;
};
#endif /* nsMimeTypeArray_h___ */