docshell/base/LoadContext.cpp

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #include "mozilla/Assertions.h"
   8 #include "mozilla/BasePrincipal.h"
   9 #include "mozilla/LoadContext.h"
  10 #include "mozilla/Preferences.h"
  11 #include "mozilla/dom/Element.h"
  12 #include "mozilla/dom/ScriptSettings.h" // for AutoJSAPI
  13 #include "nsContentUtils.h"
  14 #include "xpcpublic.h"
  15
  16 namespace mozilla {
  17
  18 NS_IMPL_ISUPPORTS(LoadContext, nsILoadContext, nsIInterfaceRequestor)
  19
  20 LoadContext::LoadContext(nsIPrincipal* aPrincipal,
  21                          nsILoadContext* aOptionalBase)
  22   : mTopFrameElement(nullptr)
  23   , mNestedFrameId(0)
  24   , mIsContent(true)
  25   , mUseRemoteTabs(false)
  26   , mUseTrackingProtection(false)
  27 #ifdef DEBUG
  28   , mIsNotNull(true)
  29 #endif
  30 {
  31   mOriginAttributes = aPrincipal->OriginAttributesRef();
  32   if (!aOptionalBase) {
  33     return;
  34   }
  35
  36   MOZ_ALWAYS_SUCCEEDS(aOptionalBase->GetIsContent(&mIsContent));
  37   MOZ_ALWAYS_SUCCEEDS(aOptionalBase->GetUseRemoteTabs(&mUseRemoteTabs));
  38   MOZ_ALWAYS_SUCCEEDS(aOptionalBase->GetUseTrackingProtection(&mUseTrackingProtection));
  39 }
  40
  41 //-----------------------------------------------------------------------------
  42 // LoadContext::nsILoadContext
  43 //-----------------------------------------------------------------------------
  44
  45 NS_IMETHODIMP
  46 LoadContext::GetAssociatedWindow(mozIDOMWindowProxy**)
  47 {
  48   MOZ_ASSERT(mIsNotNull);
  49
  50   // can't support this in the parent process
  51   return NS_ERROR_UNEXPECTED;
  52 }
  53
  54 NS_IMETHODIMP
  55 LoadContext::GetTopWindow(mozIDOMWindowProxy**)
  56 {
  57   MOZ_ASSERT(mIsNotNull);
  58
  59   // can't support this in the parent process
  60   return NS_ERROR_UNEXPECTED;
  61 }
  62
  63 NS_IMETHODIMP
  64 LoadContext::GetTopFrameElement(dom::Element** aElement)
  65 {
  66   nsCOMPtr<dom::Element> element = do_QueryReferent(mTopFrameElement);
  67   element.forget(aElement);
  68   return NS_OK;
  69 }
  70
  71 NS_IMETHODIMP
  72 LoadContext::GetNestedFrameId(uint64_t* aId)
  73 {
  74   NS_ENSURE_ARG(aId);
  75   *aId = mNestedFrameId;
  76   return NS_OK;
  77 }
  78
  79 NS_IMETHODIMP
  80 LoadContext::GetIsContent(bool* aIsContent)
  81 {
  82   MOZ_ASSERT(mIsNotNull);
  83
  84   NS_ENSURE_ARG_POINTER(aIsContent);
  85
  86   *aIsContent = mIsContent;
  87   return NS_OK;
  88 }
  89
  90 NS_IMETHODIMP
  91 LoadContext::GetUsePrivateBrowsing(bool* aUsePrivateBrowsing)
  92 {
  93   MOZ_ASSERT(mIsNotNull);
  94
  95   NS_ENSURE_ARG_POINTER(aUsePrivateBrowsing);
  96
  97   *aUsePrivateBrowsing = mOriginAttributes.mPrivateBrowsingId > 0;
  98   return NS_OK;
  99 }
 100
 101 NS_IMETHODIMP
 102 LoadContext::SetUsePrivateBrowsing(bool aUsePrivateBrowsing)
 103 {
 104   MOZ_ASSERT(mIsNotNull);
 105
 106   // We shouldn't need this on parent...
 107   return NS_ERROR_UNEXPECTED;
 108 }
 109
 110 NS_IMETHODIMP
 111 LoadContext::SetPrivateBrowsing(bool aUsePrivateBrowsing)
 112 {
 113   MOZ_ASSERT(mIsNotNull);
 114
 115   // We shouldn't need this on parent...
 116   return NS_ERROR_UNEXPECTED;
 117 }
 118
 119 NS_IMETHODIMP
 120 LoadContext::GetUseRemoteTabs(bool* aUseRemoteTabs)
 121 {
 122   MOZ_ASSERT(mIsNotNull);
 123
 124   NS_ENSURE_ARG_POINTER(aUseRemoteTabs);
 125
 126   *aUseRemoteTabs = mUseRemoteTabs;
 127   return NS_OK;
 128 }
 129
 130 NS_IMETHODIMP
 131 LoadContext::SetRemoteTabs(bool aUseRemoteTabs)
 132 {
 133   MOZ_ASSERT(mIsNotNull);
 134
 135   // We shouldn't need this on parent...
 136   return NS_ERROR_UNEXPECTED;
 137 }
 138
 139 NS_IMETHODIMP
 140 LoadContext::GetIsInIsolatedMozBrowserElement(bool* aIsInIsolatedMozBrowserElement)
 141 {
 142   MOZ_ASSERT(mIsNotNull);
 143
 144   NS_ENSURE_ARG_POINTER(aIsInIsolatedMozBrowserElement);
 145
 146   *aIsInIsolatedMozBrowserElement = mOriginAttributes.mInIsolatedMozBrowser;
 147   return NS_OK;
 148 }
 149
 150 NS_IMETHODIMP
 151 LoadContext::GetScriptableOriginAttributes(JS::MutableHandleValue aAttrs)
 152 {
 153   JSContext* cx = nsContentUtils::GetCurrentJSContext();
 154   MOZ_ASSERT(cx);
 155
 156   bool ok = ToJSValue(cx, mOriginAttributes, aAttrs);
 157   NS_ENSURE_TRUE(ok, NS_ERROR_FAILURE);
 158   return NS_OK;
 159 }
 160
 161 NS_IMETHODIMP_(void)
 162 LoadContext::GetOriginAttributes(mozilla::OriginAttributes& aAttrs)
 163 {
 164   aAttrs = mOriginAttributes;
 165 }
 166
 167 NS_IMETHODIMP
 168 LoadContext::GetUseTrackingProtection(bool* aUseTrackingProtection)
 169 {
 170   MOZ_ASSERT(mIsNotNull);
 171
 172   NS_ENSURE_ARG_POINTER(aUseTrackingProtection);
 173
 174   *aUseTrackingProtection = mUseTrackingProtection;
 175   return NS_OK;
 176 }
 177
 178 NS_IMETHODIMP
 179 LoadContext::SetUseTrackingProtection(bool aUseTrackingProtection)
 180 {
 181   MOZ_ASSERT_UNREACHABLE("Should only be set through nsDocShell");
 182
 183   return NS_ERROR_UNEXPECTED;
 184 }
 185
 186 //-----------------------------------------------------------------------------
 187 // LoadContext::nsIInterfaceRequestor
 188 //-----------------------------------------------------------------------------
 189 NS_IMETHODIMP
 190 LoadContext::GetInterface(const nsIID& aIID, void** aResult)
 191 {
 192   NS_ENSURE_ARG_POINTER(aResult);
 193   *aResult = nullptr;
 194
 195   if (aIID.Equals(NS_GET_IID(nsILoadContext))) {
 196     *aResult = static_cast<nsILoadContext*>(this);
 197     NS_ADDREF_THIS();
 198     return NS_OK;
 199   }
 200
 201   return NS_NOINTERFACE;
 202 }
 203
 204 static nsresult
 205 CreateTestInstance(bool aPrivate, nsISupports *aOuter, REFNSIID aIID, void **aResult)
 206 {
 207   // Shamelessly modified from NS_GENERIC_FACTORY_CONSTRUCTOR
 208   *aResult = nullptr;
 209
 210   if (aOuter) {
 211     return NS_ERROR_NO_AGGREGATION;
 212   }
 213
 214   OriginAttributes oa;
 215   oa.mPrivateBrowsingId = aPrivate ? 1 : 0;
 216
 217   RefPtr<LoadContext> lc = new LoadContext(oa);
 218
 219   return lc->QueryInterface(aIID, aResult);
 220 }
 221
 222 nsresult
 223 CreateTestLoadContext(nsISupports *aOuter, REFNSIID aIID, void **aResult)
 224 {
 225   return CreateTestInstance(false, aOuter, aIID, aResult);
 226 }
 227
 228 nsresult
 229 CreatePrivateTestLoadContext(nsISupports *aOuter, REFNSIID aIID, void **aResult)
 230 {
 231   return CreateTestInstance(true, aOuter, aIID, aResult);
 232 }
 233
 234 } // namespace mozilla