summaryrefslogtreecommitdiffstats
path: root/dom/base/nsPluginArray.h
blob: 7b1cc6544075abd54f03e29b1c347edfbc28c72d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
/* -*- 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 nsPluginArray_h___
#define nsPluginArray_h___

#include "nsWeakReference.h"
#include "nsWrapperCache.h"
#include "nsCOMPtr.h"
#include "nsString.h"
#include "nsTArray.h"
#include "mozilla/Array.h"

class nsPIDOMWindowInner;
class nsPluginElement;
class nsMimeTypeArray;
class nsMimeType;

/**
 * Array class backing HTML's navigator.plugins.  This always holds references
 * to the hard-coded set of PDF plugins 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 nsPluginArray final : public nsSupportsWeakReference,
                            public nsWrapperCache {
 public:
  NS_DECL_CYCLE_COLLECTING_ISUPPORTS
  NS_DECL_CYCLE_COLLECTION_WRAPPERCACHE_CLASS(nsPluginArray)

  explicit nsPluginArray(nsPIDOMWindowInner* aWindow);
  nsPIDOMWindowInner* GetParentObject() const;
  virtual JSObject* WrapObject(JSContext* aCx,
                               JS::Handle<JSObject*> aGivenProto) override;

  nsMimeTypeArray* MimeTypeArray() { return mMimeTypeArray; }

  // PluginArray WebIDL methods
  uint32_t Length() { return ForceNoPlugins() ? 0 : ArrayLength(mPlugins); }

  nsPluginElement* Item(uint32_t aIndex) {
    bool unused;
    return IndexedGetter(aIndex, unused);
  }

  nsPluginElement* NamedItem(const nsAString& aName) {
    bool unused;
    return NamedGetter(aName, unused);
  }

  nsPluginElement* IndexedGetter(uint32_t aIndex, bool& aFound);

  nsPluginElement* NamedGetter(const nsAString& aName, bool& aFound);

  void GetSupportedNames(nsTArray<nsString>& aRetval);

  void Refresh() {}

 private:
  virtual ~nsPluginArray();

  bool ForceNoPlugins();

  RefPtr<nsMimeTypeArray> mMimeTypeArray;
  nsCOMPtr<nsPIDOMWindowInner> mWindow;
  mozilla::Array<RefPtr<nsPluginElement>, 5> mPlugins;
};

/**
 * Plugin class backing entries in HTML's navigator.plugins array.  There is
 * a fixed set of these, as defined by HTML.
 */
class nsPluginElement final : public nsISupports, public nsWrapperCache {
 public:
  NS_DECL_CYCLE_COLLECTING_ISUPPORTS
  NS_DECL_CYCLE_COLLECTION_WRAPPERCACHE_CLASS(nsPluginElement)

  explicit nsPluginElement(nsPluginArray* aPluginArray,
                           nsPIDOMWindowInner* aWindow, const nsAString& aName);

  nsPluginArray* GetParentObject() const;

  virtual JSObject* WrapObject(JSContext* aCx,
                               JS::Handle<JSObject*> aGivenProto) override;

  // Plugin WebIDL methods
  void GetDescription(nsString& retval) const { retval = kDescription; }

  void GetFilename(nsString& retval) const { retval = kFilename; }

  void GetName(nsString& retval) const { retval = mName; }
  const nsString& Name() const { return mName; }

  nsMimeType* Item(uint32_t index) {
    bool unused;
    return IndexedGetter(index, unused);
  }

  nsMimeType* NamedItem(const nsAString& name) {
    bool unused;
    return NamedGetter(name, unused);
  }

  uint32_t Length();

  nsMimeType* IndexedGetter(uint32_t index, bool& found);

  nsMimeType* NamedGetter(const nsAString& name, bool& found);

  void GetSupportedNames(nsTArray<nsString>& retval);

 protected:
  virtual ~nsPluginElement() = default;

  nsMimeTypeArray* MimeTypeArray() { return mPluginArray->MimeTypeArray(); }

  static constexpr nsLiteralString kDescription =
      u"Portable Document Format"_ns;
  static constexpr nsLiteralString kFilename = u"internal-pdf-viewer"_ns;

  // Note that this creates an explicit reference cycle:
  //
  // nsPluginElement -> nsPluginArray -> nsPluginElement
  //
  // We rely on the cycle collector to break this cycle.
  RefPtr<nsPluginArray> mPluginArray;
  nsCOMPtr<nsPIDOMWindowInner> mWindow;
  nsString mName;
};

#endif /* nsPluginArray_h___ */