dom/fetch/InternalRequest.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #ifndef mozilla_dom_InternalRequest_h
   7 #define mozilla_dom_InternalRequest_h
   8
   9 #include "mozilla/dom/HeadersBinding.h"
  10 #include "mozilla/dom/InternalHeaders.h"
  11 #include "mozilla/dom/RequestBinding.h"
  12
  13 #include "nsIContentPolicy.h"
  14 #include "nsIInputStream.h"
  15 #include "nsISupportsImpl.h"
  16
  17 class nsIDocument;
  18 class nsPIDOMWindow;
  19
  20 namespace mozilla {
  21 namespace dom {
  22
  23 class FetchBodyStream;
  24 class Request;
  25
  26 class InternalRequest MOZ_FINAL
  27 {
  28   friend class Request;
  29
  30 public:
  31   NS_INLINE_DECL_THREADSAFE_REFCOUNTING(InternalRequest)
  32
  33   enum ContextFrameType
  34   {
  35     FRAMETYPE_AUXILIARY = 0,
  36     FRAMETYPE_TOP_LEVEL,
  37     FRAMETYPE_NESTED,
  38     FRAMETYPE_NONE,
  39   };
  40
  41   // Since referrer type can be none, client or a URL.
  42   enum ReferrerType
  43   {
  44     REFERRER_NONE = 0,
  45     REFERRER_CLIENT,
  46     REFERRER_URL,
  47   };
  48
  49   enum ResponseTainting
  50   {
  51     RESPONSETAINT_BASIC,
  52     RESPONSETAINT_CORS,
  53     RESPONSETAINT_OPAQUE,
  54   };
  55
  56   explicit InternalRequest()
  57     : mMethod("GET")
  58     , mHeaders(new InternalHeaders(HeadersGuardEnum::None))
  59     , mContextFrameType(FRAMETYPE_NONE)
  60     , mReferrerType(REFERRER_CLIENT)
  61     , mMode(RequestMode::No_cors)
  62     , mCredentialsMode(RequestCredentials::Omit)
  63     , mResponseTainting(RESPONSETAINT_BASIC)
  64     , mRedirectCount(0)
  65     , mAuthenticationFlag(false)
  66     , mForceOriginHeader(false)
  67     , mManualRedirect(false)
  68     , mPreserveContentCodings(false)
  69       // FIXME(nsm): This should be false by default, but will lead to the
  70       // algorithm never loading data: URLs right now. See Bug 1018872 about
  71       // how certain contexts will override it to set it to true. Fetch
  72       // specification does not handle this yet.
  73     , mSameOriginDataURL(true)
  74     , mSkipServiceWorker(false)
  75     , mSynchronous(false)
  76     , mUnsafeRequest(false)
  77     , mUseURLCredentials(false)
  78   {
  79   }
  80
  81   explicit InternalRequest(const InternalRequest& aOther)
  82     : mMethod(aOther.mMethod)
  83     , mURL(aOther.mURL)
  84     , mHeaders(aOther.mHeaders)
  85     , mBodyStream(aOther.mBodyStream)
  86     , mContext(aOther.mContext)
  87     , mOrigin(aOther.mOrigin)
  88     , mContextFrameType(aOther.mContextFrameType)
  89     , mReferrerType(aOther.mReferrerType)
  90     , mReferrerURL(aOther.mReferrerURL)
  91     , mMode(aOther.mMode)
  92     , mCredentialsMode(aOther.mCredentialsMode)
  93     , mResponseTainting(aOther.mResponseTainting)
  94     , mRedirectCount(aOther.mRedirectCount)
  95     , mAuthenticationFlag(aOther.mAuthenticationFlag)
  96     , mForceOriginHeader(aOther.mForceOriginHeader)
  97     , mManualRedirect(aOther.mManualRedirect)
  98     , mPreserveContentCodings(aOther.mPreserveContentCodings)
  99     , mSameOriginDataURL(aOther.mSameOriginDataURL)
 100     , mSandboxedStorageAreaURLs(aOther.mSandboxedStorageAreaURLs)
 101     , mSkipServiceWorker(aOther.mSkipServiceWorker)
 102     , mSynchronous(aOther.mSynchronous)
 103     , mUnsafeRequest(aOther.mUnsafeRequest)
 104     , mUseURLCredentials(aOther.mUseURLCredentials)
 105   {
 106   }
 107
 108   void
 109   GetMethod(nsCString& aMethod) const
 110   {
 111     aMethod.Assign(mMethod);
 112   }
 113
 114   void
 115   SetMethod(const nsACString& aMethod)
 116   {
 117     mMethod.Assign(aMethod);
 118   }
 119
 120   bool
 121   HasSimpleMethod() const
 122   {
 123     return mMethod.LowerCaseEqualsASCII("get") ||
 124            mMethod.LowerCaseEqualsASCII("post") ||
 125            mMethod.LowerCaseEqualsASCII("head");
 126   }
 127
 128   void
 129   GetURL(nsCString& aURL) const
 130   {
 131     aURL.Assign(mURL);
 132   }
 133
 134   bool
 135   ReferrerIsNone() const
 136   {
 137     return mReferrerType == REFERRER_NONE;
 138   }
 139
 140   bool
 141   ReferrerIsURL() const
 142   {
 143     return mReferrerType == REFERRER_URL;
 144   }
 145
 146   bool
 147   ReferrerIsClient() const
 148   {
 149     return mReferrerType == REFERRER_CLIENT;
 150   }
 151
 152   nsCString
 153   ReferrerAsURL() const
 154   {
 155     MOZ_ASSERT(ReferrerIsURL());
 156     return mReferrerURL;
 157   }
 158
 159   void
 160   SetReferrer(const nsACString& aReferrer)
 161   {
 162     // May be removed later.
 163     MOZ_ASSERT(!ReferrerIsNone());
 164     mReferrerType = REFERRER_URL;
 165     mReferrerURL.Assign(aReferrer);
 166   }
 167
 168   bool
 169   IsSynchronous() const
 170   {
 171     return mSynchronous;
 172   }
 173
 174   RequestMode
 175   Mode() const
 176   {
 177     return mMode;
 178   }
 179
 180   void
 181   SetMode(RequestMode aMode)
 182   {
 183     mMode = aMode;
 184   }
 185
 186   void
 187   SetCredentialsMode(RequestCredentials aCredentialsMode)
 188   {
 189     mCredentialsMode = aCredentialsMode;
 190   }
 191
 192   ResponseTainting
 193   GetResponseTainting() const
 194   {
 195     return mResponseTainting;
 196   }
 197
 198   void
 199   SetResponseTainting(ResponseTainting aTainting)
 200   {
 201     mResponseTainting = aTainting;
 202   }
 203
 204   nsContentPolicyType
 205   GetContext() const
 206   {
 207     return mContext;
 208   }
 209
 210   bool
 211   UnsafeRequest() const
 212   {
 213     return mUnsafeRequest;
 214   }
 215
 216   InternalHeaders*
 217   Headers()
 218   {
 219     return mHeaders;
 220   }
 221
 222   bool
 223   ForceOriginHeader()
 224   {
 225     return mForceOriginHeader;
 226   }
 227
 228   void
 229   GetOrigin(nsCString& aOrigin) const
 230   {
 231     aOrigin.Assign(mOrigin);
 232   }
 233
 234   bool
 235   SameOriginDataURL() const
 236   {
 237     return mSameOriginDataURL;
 238   }
 239
 240   void
 241   SetBody(nsIInputStream* aStream)
 242   {
 243     mBodyStream = aStream;
 244   }
 245
 246   // Will return the original stream!
 247   // Use a tee or copy if you don't want to erase the original.
 248   void
 249   GetBody(nsIInputStream** aStream)
 250   {
 251     nsCOMPtr<nsIInputStream> s = mBodyStream;
 252     s.forget(aStream);
 253   }
 254
 255   // The global is used as the client for the new object.
 256   already_AddRefed<InternalRequest>
 257   GetRequestConstructorCopy(nsIGlobalObject* aGlobal, ErrorResult& aRv) const;
 258
 259 private:
 260   ~InternalRequest();
 261
 262   void
 263   SetURL(const nsACString& aURL)
 264   {
 265     mURL.Assign(aURL);
 266   }
 267
 268   nsCString mMethod;
 269   nsCString mURL;
 270   nsRefPtr<InternalHeaders> mHeaders;
 271   nsCOMPtr<nsIInputStream> mBodyStream;
 272
 273   // nsContentPolicyType does not cover the complete set defined in the spec,
 274   // but it is a good start.
 275   nsContentPolicyType mContext;
 276
 277   nsCString mOrigin;
 278
 279   ContextFrameType mContextFrameType;
 280   ReferrerType mReferrerType;
 281
 282   // When mReferrerType is REFERRER_URL.
 283   nsCString mReferrerURL;
 284
 285   RequestMode mMode;
 286   RequestCredentials mCredentialsMode;
 287   ResponseTainting mResponseTainting;
 288
 289   uint32_t mRedirectCount;
 290
 291   bool mAuthenticationFlag;
 292   bool mForceOriginHeader;
 293   bool mManualRedirect;
 294   bool mPreserveContentCodings;
 295   bool mSameOriginDataURL;
 296   bool mSandboxedStorageAreaURLs;
 297   bool mSkipServiceWorker;
 298   bool mSynchronous;
 299   bool mUnsafeRequest;
 300   bool mUseURLCredentials;
 301 };
 302
 303 } // namespace dom
 304 } // namespace mozilla
 305
 306 #endif // mozilla_dom_InternalRequest_h