dom/base/Location.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_Location_h
   8 #define mozilla_dom_Location_h
   9
  10 #include "js/TypeDecls.h"
  11 #include "mozilla/ErrorResult.h"
  12 #include "mozilla/LinkedList.h"
  13 #include "mozilla/dom/BrowsingContext.h"
  14 #include "mozilla/dom/LocationBase.h"
  15 #include "nsCycleCollectionParticipant.h"
  16 #include "nsString.h"
  17 #include "nsWrapperCache.h"
  18
  19 class nsIDocShell;
  20 class nsIPrincipal;
  21 class nsIURI;
  22 class nsPIDOMWindowInner;
  23
  24 namespace mozilla::dom {
  25
  26 //*****************************************************************************
  27 // Location: Script "location" object
  28 //*****************************************************************************
  29
  30 class Location final : public nsISupports,
  31                        public LocationBase,
  32                        public nsWrapperCache,
  33                        public LinkedListElement<Location> {
  34  public:
  35   typedef BrowsingContext::LocationProxy RemoteProxy;
  36
  37   explicit Location(nsPIDOMWindowInner* aWindow);
  38
  39   NS_DECL_CYCLE_COLLECTING_ISUPPORTS
  40   NS_DECL_CYCLE_COLLECTION_WRAPPERCACHE_CLASS(Location)
  41
  42   // WebIDL API:
  43   void Assign(const nsAString& aUrl, nsIPrincipal& aSubjectPrincipal,
  44               ErrorResult& aError);
  45
  46   void Reload(bool aForceget, nsIPrincipal& aSubjectPrincipal,
  47               ErrorResult& aError);
  48
  49   void GetHref(nsAString& aHref, nsIPrincipal& aSubjectPrincipal,
  50                ErrorResult& aError) {
  51     if (!CallerSubsumes(&aSubjectPrincipal)) {
  52       aError.Throw(NS_ERROR_DOM_SECURITY_ERR);
  53       return;
  54     }
  55
  56     aError = GetHref(aHref);
  57   }
  58
  59   void GetOrigin(nsAString& aOrigin, nsIPrincipal& aSubjectPrincipal,
  60                  ErrorResult& aError);
  61
  62   void GetProtocol(nsAString& aProtocol, nsIPrincipal& aSubjectPrincipal,
  63                    ErrorResult& aError);
  64
  65   void SetProtocol(const nsAString& aProtocol, nsIPrincipal& aSubjectPrincipal,
  66                    ErrorResult& aError);
  67
  68   void GetHost(nsAString& aHost, nsIPrincipal& aSubjectPrincipal,
  69                ErrorResult& aError);
  70
  71   void SetHost(const nsAString& aHost, nsIPrincipal& aSubjectPrincipal,
  72                ErrorResult& aError);
  73
  74   void GetHostname(nsAString& aHostname, nsIPrincipal& aSubjectPrincipal,
  75                    ErrorResult& aError);
  76
  77   void SetHostname(const nsAString& aHostname, nsIPrincipal& aSubjectPrincipal,
  78                    ErrorResult& aError);
  79
  80   void GetPort(nsAString& aPort, nsIPrincipal& aSubjectPrincipal,
  81                ErrorResult& aError);
  82
  83   void SetPort(const nsAString& aPort, nsIPrincipal& aSubjectPrincipal,
  84                ErrorResult& aError);
  85
  86   void GetPathname(nsAString& aPathname, nsIPrincipal& aSubjectPrincipal,
  87                    ErrorResult& aError);
  88
  89   void SetPathname(const nsAString& aPathname, nsIPrincipal& aSubjectPrincipal,
  90                    ErrorResult& aError);
  91
  92   void GetSearch(nsAString& aSeach, nsIPrincipal& aSubjectPrincipal,
  93                  ErrorResult& aError);
  94
  95   void SetSearch(const nsAString& aSeach, nsIPrincipal& aSubjectPrincipal,
  96                  ErrorResult& aError);
  97
  98   void GetHash(nsAString& aHash, nsIPrincipal& aSubjectPrincipal,
  99                ErrorResult& aError);
 100
 101   void SetHash(const nsAString& aHash, nsIPrincipal& aSubjectPrincipal,
 102                ErrorResult& aError);
 103
 104   nsPIDOMWindowInner* GetParentObject() const { return mInnerWindow; }
 105
 106   virtual JSObject* WrapObject(JSContext* aCx,
 107                                JS::Handle<JSObject*> aGivenProto) override;
 108
 109   // Non WebIDL methods:
 110
 111   nsresult GetHref(nsAString& aHref);
 112
 113   nsresult ToString(nsAString& aString) { return GetHref(aString); }
 114
 115   void ClearCachedValues();
 116
 117  protected:
 118   virtual ~Location();
 119
 120   BrowsingContext* GetBrowsingContext() override;
 121   nsIDocShell* GetDocShell() override;
 122
 123   // In the case of jar: uris, we sometimes want the place the jar was
 124   // fetched from as the URI instead of the jar: uri itself.  Pass in
 125   // true for aGetInnermostURI when that's the case.
 126   // Note, this method can return NS_OK with a null value for aURL. This happens
 127   // if the docShell is null.
 128   nsresult GetURI(nsIURI** aURL, bool aGetInnermostURI = false);
 129
 130   bool CallerSubsumes(nsIPrincipal* aSubjectPrincipal);
 131
 132   nsString mCachedHash;
 133   nsCOMPtr<nsPIDOMWindowInner> mInnerWindow;
 134 };
 135
 136 }  // namespace mozilla::dom
 137
 138 #endif  // mozilla_dom_Location_h