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