dom/workers/XMLHttpRequest.h

   1 /* -*- Mode: c++; c-basic-offset: 2; indent-tabs-mode: nil; tab-width: 40 -*- */
   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 file,
   4  * You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #ifndef mozilla_dom_workers_xmlhttprequest_h__
   7 #define mozilla_dom_workers_xmlhttprequest_h__
   8
   9 #include "mozilla/dom/workers/bindings/WorkerFeature.h"
  10
  11 // Need this for XMLHttpRequestResponseType.
  12 #include "mozilla/dom/XMLHttpRequestBinding.h"
  13
  14 #include "mozilla/dom/TypedArray.h"
  15
  16 #include "js/StructuredClone.h"
  17 #include "nsXMLHttpRequest.h"
  18
  19 BEGIN_WORKERS_NAMESPACE
  20
  21 class Proxy;
  22 class XMLHttpRequestUpload;
  23 class WorkerPrivate;
  24
  25 class XMLHttpRequest MOZ_FINAL: public nsXHREventTarget,
  26                                 public WorkerFeature
  27 {
  28 public:
  29   struct StateData
  30   {
  31     nsString mResponseText;
  32     nsString mResponseURL;
  33     uint32_t mStatus;
  34     nsCString mStatusText;
  35     uint16_t mReadyState;
  36     JS::Heap<JS::Value> mResponse;
  37     nsresult mResponseTextResult;
  38     nsresult mStatusResult;
  39     nsresult mResponseResult;
  40
  41     StateData()
  42     : mStatus(0), mReadyState(0), mResponse(JSVAL_VOID),
  43       mResponseTextResult(NS_OK), mStatusResult(NS_OK),
  44       mResponseResult(NS_OK)
  45     { }
  46   };
  47
  48 private:
  49   nsRefPtr<XMLHttpRequestUpload> mUpload;
  50   WorkerPrivate* mWorkerPrivate;
  51   nsRefPtr<Proxy> mProxy;
  52   XMLHttpRequestResponseType mResponseType;
  53   StateData mStateData;
  54
  55   uint32_t mTimeout;
  56
  57   bool mRooted;
  58   bool mBackgroundRequest;
  59   bool mWithCredentials;
  60   bool mCanceled;
  61
  62   bool mMozAnon;
  63   bool mMozSystem;
  64
  65 public:
  66   virtual JSObject*
  67   WrapObject(JSContext* aCx) MOZ_OVERRIDE;
  68
  69   NS_DECL_ISUPPORTS_INHERITED
  70   NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_CLASS_INHERITED(XMLHttpRequest,
  71                                                          nsXHREventTarget)
  72
  73   nsISupports*
  74   GetParentObject() const
  75   {
  76     // There's only one global on a worker, so we don't need to specify.
  77     return nullptr;
  78   }
  79
  80   static already_AddRefed<XMLHttpRequest>
  81   Constructor(const GlobalObject& aGlobal,
  82               const MozXMLHttpRequestParameters& aParams,
  83               ErrorResult& aRv);
  84
  85   static already_AddRefed<XMLHttpRequest>
  86   Constructor(const GlobalObject& aGlobal, const nsAString& ignored,
  87               ErrorResult& aRv)
  88   {
  89     // Pretend like someone passed null, so we can pick up the default values
  90     MozXMLHttpRequestParameters params;
  91     if (!params.Init(aGlobal.Context(), JS::NullHandleValue)) {
  92       aRv.Throw(NS_ERROR_UNEXPECTED);
  93       return nullptr;
  94     }
  95
  96     return Constructor(aGlobal, params, aRv);
  97   }
  98
  99   void
 100   Unpin();
 101
 102   bool
 103   Notify(JSContext* aCx, Status aStatus) MOZ_OVERRIDE;
 104
 105   IMPL_EVENT_HANDLER(readystatechange)
 106
 107   uint16_t
 108   ReadyState() const
 109   {
 110     return mStateData.mReadyState;
 111   }
 112
 113   void Open(const nsACString& aMethod, const nsAString& aUrl, ErrorResult& aRv)
 114   {
 115     Open(aMethod, aUrl, true, Optional<nsAString>(),
 116          Optional<nsAString>(), aRv);
 117   }
 118   void
 119   Open(const nsACString& aMethod, const nsAString& aUrl, bool aAsync,
 120        const Optional<nsAString>& aUser, const Optional<nsAString>& aPassword,
 121        ErrorResult& aRv);
 122
 123   void
 124   SetRequestHeader(const nsACString& aHeader, const nsACString& aValue,
 125                    ErrorResult& aRv);
 126
 127   uint32_t
 128   Timeout() const
 129   {
 130     return mTimeout;
 131   }
 132
 133   void
 134   SetTimeout(uint32_t aTimeout, ErrorResult& aRv);
 135
 136   bool
 137   WithCredentials() const
 138   {
 139     return mWithCredentials;
 140   }
 141
 142   void
 143   SetWithCredentials(bool aWithCredentials, ErrorResult& aRv);
 144
 145   bool
 146   MozBackgroundRequest() const
 147   {
 148     return mBackgroundRequest;
 149   }
 150
 151   void
 152   SetMozBackgroundRequest(bool aBackgroundRequest, ErrorResult& aRv);
 153
 154   XMLHttpRequestUpload*
 155   GetUpload(ErrorResult& aRv);
 156
 157   void
 158   Send(ErrorResult& aRv);
 159
 160   void
 161   Send(const nsAString& aBody, ErrorResult& aRv);
 162
 163   void
 164   Send(JS::Handle<JSObject*> aBody, ErrorResult& aRv);
 165
 166   void
 167   Send(const ArrayBuffer& aBody, ErrorResult& aRv);
 168
 169   void
 170   Send(const ArrayBufferView& aBody, ErrorResult& aRv);
 171
 172   void
 173   SendAsBinary(const nsAString& aBody, ErrorResult& aRv);
 174
 175   void
 176   Abort(ErrorResult& aRv);
 177
 178   void
 179   GetResponseURL(nsAString& aUrl) const
 180   {
 181     aUrl = mStateData.mResponseURL;
 182   }
 183
 184   uint16_t
 185   GetStatus(ErrorResult& aRv) const
 186   {
 187     aRv = mStateData.mStatusResult;
 188     return mStateData.mStatus;
 189   }
 190
 191   void
 192   GetStatusText(nsACString& aStatusText) const
 193   {
 194     aStatusText = mStateData.mStatusText;
 195   }
 196
 197   void
 198   GetResponseHeader(const nsACString& aHeader, nsACString& aResponseHeader,
 199                     ErrorResult& aRv);
 200
 201   void
 202   GetAllResponseHeaders(nsACString& aResponseHeaders, ErrorResult& aRv);
 203
 204   void
 205   OverrideMimeType(const nsAString& aMimeType, ErrorResult& aRv);
 206
 207   XMLHttpRequestResponseType
 208   ResponseType() const
 209   {
 210     return mResponseType;
 211   }
 212
 213   void
 214   SetResponseType(XMLHttpRequestResponseType aResponseType, ErrorResult& aRv);
 215
 216   void
 217   GetResponse(JSContext* /* unused */, JS::MutableHandle<JS::Value> aResponse,
 218               ErrorResult& aRv);
 219
 220   void
 221   GetResponseText(nsAString& aResponseText, ErrorResult& aRv);
 222
 223   void
 224   GetInterface(JSContext* cx, JS::Handle<JSObject*> aIID,
 225                JS::MutableHandle<JS::Value> aRetval, ErrorResult& aRv)
 226   {
 227     aRv.Throw(NS_ERROR_FAILURE);
 228   }
 229
 230   XMLHttpRequestUpload*
 231   GetUploadObjectNoCreate() const
 232   {
 233     return mUpload;
 234   }
 235
 236   void
 237   UpdateState(const StateData& aStateData, bool aUseCachedArrayBufferResponse);
 238
 239   void
 240   NullResponseText()
 241   {
 242     mStateData.mResponseText.SetIsVoid(true);
 243     mStateData.mResponse = JSVAL_NULL;
 244   }
 245
 246   bool MozAnon() const
 247   {
 248     return mMozAnon;
 249   }
 250
 251   bool MozSystem() const
 252   {
 253     return mMozSystem;
 254   }
 255
 256   bool
 257   SendInProgress() const
 258   {
 259     return mRooted;
 260   }
 261
 262 private:
 263   XMLHttpRequest(WorkerPrivate* aWorkerPrivate);
 264   ~XMLHttpRequest();
 265
 266   enum ReleaseType { Default, XHRIsGoingAway, WorkerIsGoingAway };
 267
 268   void
 269   ReleaseProxy(ReleaseType aType = Default);
 270
 271   void
 272   MaybePin(ErrorResult& aRv);
 273
 274   void
 275   MaybeDispatchPrematureAbortEvents(ErrorResult& aRv);
 276
 277   void
 278   DispatchPrematureAbortEvent(EventTarget* aTarget,
 279                               const nsAString& aEventType, bool aUploadTarget,
 280                               ErrorResult& aRv);
 281
 282   void
 283   SendInternal(const nsAString& aStringBody,
 284                JSAutoStructuredCloneBuffer&& aBody,
 285                nsTArray<nsCOMPtr<nsISupports> >& aClonedObjects,
 286                ErrorResult& aRv);
 287 };
 288
 289 END_WORKERS_NAMESPACE
 290
 291 #endif // mozilla_dom_workers_xmlhttprequest_h__