dom/url/URL.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_URL_h
   8 #define mozilla_dom_URL_h
   9
  10 #include "mozilla/dom/URLSearchParams.h"
  11 #include "nsCycleCollectionParticipant.h"
  12 #include "nsIURI.h"
  13 #include "nsString.h"
  14 #include "nsWrapperCache.h"
  15
  16 class nsISupports;
  17
  18 namespace mozilla {
  19
  20 class ErrorResult;
  21
  22 namespace dom {
  23
  24 class Blob;
  25 class MediaSource;
  26 class GlobalObject;
  27 template <typename T>
  28 class Optional;
  29
  30 class URL final : public URLSearchParamsObserver, public nsWrapperCache {
  31  public:
  32   NS_DECL_CYCLE_COLLECTING_ISUPPORTS
  33   NS_DECL_CYCLE_COLLECTION_WRAPPERCACHE_CLASS(URL)
  34
  35   explicit URL(nsISupports* aParent, nsCOMPtr<nsIURI> aURI)
  36       : mParent(aParent), mURI(std::move(aURI)) {
  37     MOZ_ASSERT(mURI);
  38   }
  39
  40   // WebIDL methods
  41   nsISupports* GetParentObject() const { return mParent; }
  42
  43   JSObject* WrapObject(JSContext* aCx,
  44                        JS::Handle<JSObject*> aGivenProto) override;
  45
  46   static already_AddRefed<URL> Constructor(const GlobalObject& aGlobal,
  47                                            const nsACString& aURL,
  48                                            const Optional<nsACString>& aBase,
  49                                            ErrorResult& aRv);
  50
  51   static already_AddRefed<URL> Constructor(nsISupports* aParent,
  52                                            const nsACString& aURL,
  53                                            const nsACString& aBase,
  54                                            ErrorResult& aRv);
  55
  56   static already_AddRefed<URL> Constructor(nsISupports* aParent,
  57                                            const nsACString& aURL,
  58                                            nsIURI* aBase, ErrorResult& aRv);
  59
  60   static void CreateObjectURL(const GlobalObject& aGlobal, Blob& aBlob,
  61                               nsACString& aResult, ErrorResult& aRv);
  62
  63   static void CreateObjectURL(const GlobalObject& aGlobal, MediaSource& aSource,
  64                               nsACString& aResult, ErrorResult& aRv);
  65
  66   static void RevokeObjectURL(const GlobalObject& aGlobal,
  67                               const nsACString& aURL, ErrorResult& aRv);
  68
  69   static bool IsValidObjectURL(const GlobalObject& aGlobal,
  70                                const nsACString& aURL, ErrorResult& aRv);
  71
  72   static already_AddRefed<URL> Parse(const GlobalObject& aGlobal,
  73                                      const nsACString& aURL,
  74                                      const Optional<nsACString>& aBase);
  75
  76   static bool CanParse(const GlobalObject& aGlobal, const nsACString& aURL,
  77                        const Optional<nsACString>& aBase);
  78
  79   void GetHref(nsACString& aHref) const;
  80   void SetHref(const nsACString& aHref, ErrorResult& aRv);
  81
  82   void GetOrigin(nsACString& aOrigin) const;
  83
  84   void GetProtocol(nsACString& aProtocol) const;
  85   void SetProtocol(const nsACString& aProtocol);
  86
  87   void GetUsername(nsACString& aUsername) const;
  88   void SetUsername(const nsACString& aUsername);
  89
  90   void GetPassword(nsACString& aPassword) const;
  91   void SetPassword(const nsACString& aPassword);
  92
  93   void GetHost(nsACString& aHost) const;
  94   void SetHost(const nsACString& aHost);
  95
  96   void GetHostname(nsACString& aHostname) const;
  97   void SetHostname(const nsACString& aHostname);
  98
  99   void GetPort(nsACString& aPort) const;
 100   void SetPort(const nsACString& aPort);
 101
 102   void GetPathname(nsACString& aPathname) const;
 103   void SetPathname(const nsACString& aPathname);
 104
 105   void GetSearch(nsACString& aSearch) const;
 106   void SetSearch(const nsACString& aSearch);
 107
 108   URLSearchParams* SearchParams();
 109
 110   void GetHash(nsACString& aHash) const;
 111   void SetHash(const nsACString& aHash);
 112
 113   void ToJSON(nsACString& aResult) const { GetHref(aResult); }
 114
 115   // URLSearchParamsObserver
 116   void URLSearchParamsUpdated(URLSearchParams* aSearchParams) override;
 117
 118   nsIURI* URI() const;
 119   static already_AddRefed<URL> FromURI(GlobalObject&, nsIURI*);
 120
 121  private:
 122   ~URL() = default;
 123
 124   static already_AddRefed<nsIURI> ParseURI(const nsACString& aURL,
 125                                            const Optional<nsACString>& aBase);
 126
 127   void UpdateURLSearchParams();
 128
 129  private:
 130   void SetSearchInternal(const nsACString& aSearch);
 131
 132   void CreateSearchParamsIfNeeded();
 133
 134   nsCOMPtr<nsISupports> mParent;
 135   RefPtr<URLSearchParams> mSearchParams;
 136   nsCOMPtr<nsIURI> mURI;
 137 };
 138
 139 bool IsChromeURI(nsIURI* aURI);
 140
 141 }  // namespace dom
 142 }  // namespace mozilla
 143
 144 #endif /* mozilla_dom_URL_h */