dom/fetch/Request.h

   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 #ifndef mozilla_dom_Request_h
   8 #define mozilla_dom_Request_h
   9
  10 #include "nsISupportsImpl.h"
  11 #include "nsWrapperCache.h"
  12
  13 #include "mozilla/dom/Fetch.h"
  14 #include "mozilla/dom/InternalRequest.h"
  15 // Required here due to certain WebIDL enums/classes being declared in both
  16 // files.
  17 #include "mozilla/dom/RequestBinding.h"
  18 #include "mozilla/dom/SafeRefPtr.h"
  19
  20 namespace mozilla::dom {
  21
  22 class Headers;
  23 class InternalHeaders;
  24 class RequestOrUTF8String;
  25
  26 class Request final : public FetchBody<Request>, public nsWrapperCache {
  27   NS_DECL_ISUPPORTS_INHERITED
  28   NS_DECL_CYCLE_COLLECTION_WRAPPERCACHE_CLASS_INHERITED(Request,
  29                                                         FetchBody<Request>)
  30
  31  public:
  32   Request(nsIGlobalObject* aOwner, SafeRefPtr<InternalRequest> aRequest,
  33           AbortSignal* aSignal);
  34
  35   JSObject* WrapObject(JSContext* aCx,
  36                        JS::Handle<JSObject*> aGivenProto) override {
  37     return Request_Binding::Wrap(aCx, this, aGivenProto);
  38   }
  39
  40   void GetUrl(nsACString& aUrl) const { mRequest->GetURL(aUrl); }
  41   void GetMethod(nsCString& aMethod) const { aMethod = mRequest->mMethod; }
  42
  43   RequestMode Mode() const { return mRequest->mMode; }
  44
  45   RequestCredentials Credentials() const { return mRequest->mCredentialsMode; }
  46
  47   RequestCache Cache() const { return mRequest->GetCacheMode(); }
  48
  49   RequestRedirect Redirect() const { return mRequest->GetRedirectMode(); }
  50
  51   RequestPriority Priority() const { return mRequest->GetPriorityMode(); }
  52
  53   void GetIntegrity(nsAString& aIntegrity) const {
  54     aIntegrity = mRequest->GetIntegrity();
  55   }
  56
  57   bool Keepalive() const { return mRequest->GetKeepalive(); }
  58
  59   bool MozErrors() const { return mRequest->MozErrors(); }
  60
  61   RequestDestination Destination() const { return mRequest->Destination(); }
  62
  63   void OverrideContentPolicyType(uint32_t aContentPolicyType) {
  64     mRequest->OverrideContentPolicyType(
  65         static_cast<nsContentPolicyType>(aContentPolicyType));
  66   }
  67
  68   bool IsContentPolicyTypeOverridden() const {
  69     return mRequest->IsContentPolicyTypeOverridden();
  70   }
  71
  72   void GetReferrer(nsACString& aReferrer) const {
  73     mRequest->GetReferrer(aReferrer);
  74   }
  75
  76   ReferrerPolicy ReferrerPolicy_() const { return mRequest->ReferrerPolicy_(); }
  77
  78   InternalHeaders* GetInternalHeaders() const { return mRequest->Headers(); }
  79
  80   Headers* Headers_();
  81
  82   using FetchBody::GetBody;
  83
  84   void GetBody(nsIInputStream** aStream, int64_t* aBodyLength = nullptr) {
  85     mRequest->GetBody(aStream, aBodyLength);
  86   }
  87
  88   void SetBody(nsIInputStream* aStream, int64_t aBodyLength) {
  89     mRequest->SetBody(aStream, aBodyLength);
  90   }
  91
  92   using FetchBody::BodyBlobURISpec;
  93
  94   const nsACString& BodyBlobURISpec() const {
  95     return mRequest->BodyBlobURISpec();
  96   }
  97
  98   using FetchBody::BodyLocalPath;
  99
 100   const nsAString& BodyLocalPath() const { return mRequest->BodyLocalPath(); }
 101
 102   static SafeRefPtr<Request> Constructor(const GlobalObject& aGlobal,
 103                                          const RequestOrUTF8String& aInput,
 104                                          const RequestInit& aInit,
 105                                          ErrorResult& rv);
 106
 107   static SafeRefPtr<Request> Constructor(nsIGlobalObject* aGlobal,
 108                                          JSContext* aCx,
 109                                          const RequestOrUTF8String& aInput,
 110                                          const RequestInit& aInit,
 111                                          const CallerType aCallerType,
 112                                          ErrorResult& rv);
 113
 114   nsIGlobalObject* GetParentObject() const { return mOwner; }
 115
 116   SafeRefPtr<Request> Clone(ErrorResult& aRv);
 117
 118   SafeRefPtr<InternalRequest> GetInternalRequest();
 119
 120   const UniquePtr<mozilla::ipc::PrincipalInfo>& GetPrincipalInfo() const {
 121     return mRequest->GetPrincipalInfo();
 122   }
 123
 124   AbortSignal* GetOrCreateSignal();
 125
 126   // This can return a null AbortSignalImpl.
 127   AbortSignalImpl* GetSignalImpl() const override;
 128   AbortSignalImpl* GetSignalImplToConsumeBody() const final;
 129
 130  private:
 131   ~Request();
 132
 133   SafeRefPtr<InternalRequest> mRequest;
 134
 135   // Lazily created.
 136   RefPtr<Headers> mHeaders;
 137   RefPtr<AbortSignal> mSignal;
 138 };
 139
 140 }  // namespace mozilla::dom
 141
 142 #endif  // mozilla_dom_Request_h