dom/base/nsContentPermissionHelper.h

   1 /* This Source Code Form is subject to the terms of the Mozilla Public
   2  * License, v. 2.0. If a copy of the MPL was not distributed with this
   3  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   4
   5 #ifndef nsContentPermissionHelper_h
   6 #define nsContentPermissionHelper_h
   7
   8 #include "nsIContentPermissionPrompt.h"
   9 #include "nsTArray.h"
  10 #include "nsIMutableArray.h"
  11 #include "mozilla/dom/PContentPermissionRequestChild.h"
  12 // Microsoft's API Name hackery sucks
  13 // XXXbz Doing this in a header is a gigantic footgun. See
  14 // https://bugzilla.mozilla.org/show_bug.cgi?id=932421#c3 for why.
  15 #undef LoadImage
  16
  17 class nsPIDOMWindow;
  18 class nsContentPermissionRequestProxy;
  19
  20 // Forward declare IPC::Principal here which is defined in
  21 // PermissionMessageUtils.h. Include this file will transitively includes
  22 // "windows.h" and it defines
  23 //   #define CreateEvent CreateEventW
  24 //   #define LoadImage LoadImageW
  25 // That will mess up windows build.
  26 namespace IPC {
  27 class Principal;
  28 }
  29
  30 namespace mozilla {
  31 namespace dom {
  32
  33 class Element;
  34 class PermissionRequest;
  35 class ContentPermissionRequestParent;
  36 class PContentPermissionRequestParent;
  37
  38 class ContentPermissionType : public nsIContentPermissionType
  39 {
  40 public:
  41   NS_DECL_ISUPPORTS
  42   NS_DECL_NSICONTENTPERMISSIONTYPE
  43
  44   ContentPermissionType(const nsACString& aType,
  45                         const nsACString& aAccess,
  46                         const nsTArray<nsString>& aOptions);
  47
  48 protected:
  49   virtual ~ContentPermissionType();
  50
  51   nsCString mType;
  52   nsCString mAccess;
  53   nsTArray<nsString> mOptions;
  54 };
  55
  56 class nsContentPermissionUtils
  57 {
  58 public:
  59   static uint32_t
  60   ConvertPermissionRequestToArray(nsTArray<PermissionRequest>& aSrcArray,
  61                                   nsIMutableArray* aDesArray);
  62
  63   static uint32_t
  64   ConvertArrayToPermissionRequest(nsIArray* aSrcArray,
  65                                   nsTArray<PermissionRequest>& aDesArray);
  66
  67   static nsresult
  68   CreatePermissionArray(const nsACString& aType,
  69                         const nsACString& aAccess,
  70                         const nsTArray<nsString>& aOptions,
  71                         nsIArray** aTypesArray);
  72
  73   static PContentPermissionRequestParent*
  74   CreateContentPermissionRequestParent(const nsTArray<PermissionRequest>& aRequests,
  75                                        Element* element,
  76                                        const IPC::Principal& principal);
  77
  78   static nsresult
  79   AskPermission(nsIContentPermissionRequest* aRequest, nsPIDOMWindow* aWindow);
  80 };
  81
  82 } // namespace dom
  83 } // namespace mozilla
  84
  85 class nsContentPermissionRequestProxy : public nsIContentPermissionRequest
  86 {
  87  public:
  88   NS_DECL_ISUPPORTS
  89   NS_DECL_NSICONTENTPERMISSIONREQUEST
  90
  91   nsContentPermissionRequestProxy();
  92
  93   nsresult Init(const nsTArray<mozilla::dom::PermissionRequest>& requests,
  94                 mozilla::dom::ContentPermissionRequestParent* parent);
  95
  96   void OnParentDestroyed();
  97
  98  private:
  99   virtual ~nsContentPermissionRequestProxy();
 100
 101   // Non-owning pointer to the ContentPermissionRequestParent object which owns this proxy.
 102   mozilla::dom::ContentPermissionRequestParent* mParent;
 103   nsTArray<mozilla::dom::PermissionRequest> mPermissionRequests;
 104 };
 105
 106 /**
 107  * RemotePermissionRequest will send a prompt ipdl request to b2g process.
 108  */
 109 class RemotePermissionRequest MOZ_FINAL : public nsISupports
 110                                         , public mozilla::dom::PContentPermissionRequestChild
 111 {
 112 public:
 113   NS_DECL_ISUPPORTS
 114
 115   RemotePermissionRequest(nsIContentPermissionRequest* aRequest,
 116                           nsPIDOMWindow* aWindow);
 117
 118   // It will be called when prompt dismissed.
 119   virtual bool Recv__delete__(const bool &aAllow,
 120                               const nsTArray<PermissionChoice>& aChoices) MOZ_OVERRIDE;
 121
 122   void IPDLAddRef()
 123   {
 124     mIPCOpen = true;
 125     AddRef();
 126   }
 127
 128   void IPDLRelease()
 129   {
 130     mIPCOpen = false;
 131     Release();
 132   }
 133
 134 private:
 135   virtual ~RemotePermissionRequest()
 136   {
 137     MOZ_ASSERT(!mIPCOpen, "Protocol must not be open when RemotePermissionRequest is destroyed.");
 138   }
 139
 140   void DoAllow(JS::HandleValue aChoices);
 141   void DoCancel();
 142
 143   nsCOMPtr<nsIContentPermissionRequest> mRequest;
 144   nsCOMPtr<nsPIDOMWindow>               mWindow;
 145   bool                                  mIPCOpen;
 146 };
 147
 148 #endif // nsContentPermissionHelper_h